Smack

org.jivesoftware.smackx.workgroup.packet
Class OfferRequestProvider.OfferRequestPacket

java.lang.Object
  extended by org.jivesoftware.smack.packet.Packet
      extended by org.jivesoftware.smack.packet.IQ
          extended by org.jivesoftware.smackx.workgroup.packet.OfferRequestProvider.OfferRequestPacket
Enclosing class:
OfferRequestProvider

public static class OfferRequestProvider.OfferRequestPacket
extends IQ


Nested Class Summary
 
Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ
IQ.Type
 
Field Summary
 
Fields inherited from class org.jivesoftware.smack.packet.Packet
DEFAULT_LANGUAGE, ID_NOT_AVAILABLE
 
Constructor Summary
OfferRequestProvider.OfferRequestPacket(String userJID, String userID, int timeout, Map metaData, String sessionID, OfferContent content)
           
 
Method Summary
 String getChildElementXML()
          Returns the sub-element XML section of the IQ packet, or null if there isn't one.
 OfferContent getContent()
           
 Map getMetaData()
          Returns any meta-data associated with the offer.
 String getSessionID()
          Returns the session ID associated with the request and ensuing chat.
 int getTimeout()
          Returns the number of seconds the agent has to accept the offer before it times out.
 String getUserID()
          Returns the userID, which is either the same as the userJID or a special value that the user provided as part of their "join queue" request.
 String getUserJID()
          The JID of the user that made the "join queue" request.
 
Methods inherited from class org.jivesoftware.smack.packet.IQ
createErrorResponse, createResultIQ, getType, setType, toXML
 
Methods inherited from class org.jivesoftware.smack.packet.Packet
addExtension, deleteProperty, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OfferRequestProvider.OfferRequestPacket

public OfferRequestProvider.OfferRequestPacket(String userJID,
                                               String userID,
                                               int timeout,
                                               Map metaData,
                                               String sessionID,
                                               OfferContent content)
Method Detail

getUserID

public String getUserID()
Returns the userID, which is either the same as the userJID or a special value that the user provided as part of their "join queue" request.

Returns:
the user ID.

getUserJID

public String getUserJID()
The JID of the user that made the "join queue" request.

Returns:
the user JID.

getSessionID

public String getSessionID()
Returns the session ID associated with the request and ensuing chat. If the offer does not contain a session ID, null will be returned.

Returns:
the session id associated with the request.

getTimeout

public int getTimeout()
Returns the number of seconds the agent has to accept the offer before it times out.

Returns:
the offer timeout (in seconds).

getContent

public OfferContent getContent()

getMetaData

public Map getMetaData()
Returns any meta-data associated with the offer.

Returns:
meta-data associated with the offer.

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.