org.jivesoftware.smackx.workgroup.packet

Class OfferRequestProvider.OfferRequestPacket

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

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

All Implemented Interfaces:

org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.Packet, org.jivesoftware.smack.packet.TopLevelStreamElement

Enclosing class:

OfferRequestProvider

public static class OfferRequestProvider.OfferRequestPacket
extends org.jivesoftware.smack.packet.IQ

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder, org.jivesoftware.smack.packet.IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT
static java.lang.String	NAMESPACE

Fields inherited from class org.jivesoftware.smack.packet.IQ

IQ_ELEMENT, QUERY_ELEMENT

Fields inherited from class org.jivesoftware.smack.packet.Stanza

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor and Description
OfferRequestPacket(java.lang.String userJID, java.lang.String userID, int timeout, java.util.Map<java.lang.String,java.util.List<java.lang.String>> metaData, java.lang.String sessionID, OfferContent content)

Method Summary

Modifier and Type	Method and Description
OfferContent	getContent()
protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getMetaData() Returns any meta-data associated with the offer.
java.lang.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.
java.lang.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.
java.lang.String	getUserJID() The JID of the user that made the "join queue" request.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getType, isRequestIQ, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Stanza

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, overrideExtension, removeExtension, removeExtension, setError, setFrom, setLanguage, setPacketID, setStanzaId, setTo, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

OfferRequestPacket

public OfferRequestPacket(java.lang.String userJID,
                          java.lang.String userID,
                          int timeout,
                          java.util.Map<java.lang.String,java.util.List<java.lang.String>> metaData,
                          java.lang.String sessionID,
                          OfferContent content)

Method Detail

getUserID

public java.lang.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 java.lang.String getUserJID()

The JID of the user that made the "join queue" request.

Returns:

the user JID.

getSessionID

public java.lang.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 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getMetaData()

Returns any meta-data associated with the offer.

Returns:

meta-data associated with the offer.

getIQChildElementBuilder

protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)

Specified by:

getIQChildElementBuilder in class org.jivesoftware.smack.packet.IQ