|
Smack | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.jivesoftware.smack.packet.Packet | +--org.jivesoftware.smack.packet.IQ | +--org.jivesoftware.smack.packet.RosterPacket
Represents XMPP roster packets.
Nested Class Summary | |
static class |
RosterPacket.Item
A roster item, which consists of a JID, their name, the type of subscription, and the groups the roster item belongs to. |
static class |
RosterPacket.ItemStatus
The subscription status of a roster item. |
static class |
RosterPacket.ItemType
The subscription type of a roster item. |
Nested classes inherited from class org.jivesoftware.smack.packet.IQ |
IQ.Type |
Constructor Summary | |
RosterPacket()
|
Method Summary | |
void |
addRosterItem(RosterPacket.Item item)
Adds a roster item to the packet. |
String |
getChildElementXML()
Returns the sub-element XML section of the IQ packet, or null if there isn't one. |
int |
getRosterItemCount()
Returns the number of roster items in this roster packet. |
Iterator |
getRosterItems()
Returns an Iterator for the roster items in the packet. |
Methods inherited from class org.jivesoftware.smack.packet.IQ |
getType, setType, toXML |
Methods inherited from class org.jivesoftware.smack.packet.Packet |
addExtension, deleteProperty, getError, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, removeExtension, setError, setFrom, setPacketID, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setTo |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RosterPacket()
Method Detail |
public void addRosterItem(RosterPacket.Item item)
item
- a roster item.public int getRosterItemCount()
public Iterator getRosterItems()
public String getChildElementXML()
IQ
Generally, extensions of this class should override this method. This lets the majority of IQ XML writing be generic, with each sub-class providing just the packet-specific XML.
getChildElementXML
in class IQ
|
Smack | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |