Smack

org.jivesoftware.smackx.workgroup.packet
Class OccupantsInfo

java.lang.Object
  extended by org.jivesoftware.smack.packet.Packet
      extended by org.jivesoftware.smack.packet.IQ
          extended by org.jivesoftware.smackx.workgroup.packet.OccupantsInfo

public class OccupantsInfo
extends IQ

Packet used for requesting information about occupants of a room or for retrieving information such information.

Author:
Gaston Dombiak

Nested Class Summary
static class OccupantsInfo.OccupantInfo
           
static class OccupantsInfo.Provider
          Packet extension provider for AgentStatusRequest packets.
 
Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ
IQ.Type
 
Field Summary
static String ELEMENT_NAME
          Element name of the packet extension.
static String NAMESPACE
          Namespace of the packet extension.
 
Fields inherited from class org.jivesoftware.smack.packet.Packet
ID_NOT_AVAILABLE
 
Constructor Summary
OccupantsInfo(String roomID)
           
 
Method Summary
 String getChildElementXML()
          Returns the sub-element XML section of the IQ packet, or null if there isn't one.
 Set<OccupantsInfo.OccupantInfo> getOccupants()
           
 int getOccupantsCount()
           
 String getRoomID()
           
 
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, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, removeExtension, setError, setFrom, setPacketID, setProperty, setTo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME
Element name of the packet extension.

See Also:
Constant Field Values

NAMESPACE

public static final String NAMESPACE
Namespace of the packet extension.

See Also:
Constant Field Values
Constructor Detail

OccupantsInfo

public OccupantsInfo(String roomID)
Method Detail

getRoomID

public String getRoomID()

getOccupantsCount

public int getOccupantsCount()

getOccupants

public Set<OccupantsInfo.OccupantInfo> getOccupants()

getChildElementXML

public String getChildElementXML()
Description copied from class: IQ
Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Specified by:
getChildElementXML in class IQ
Returns:
the child element section of the IQ XML.

Smack

Copyright © 2003-2007 Jive Software.