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:

Element, TopLevelStreamElement

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.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static 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(Jid userJID, Jid userID, int timeout, Map<String,List<String>> metaData, String sessionID, OfferContent content)

Method Summary

Modifier and Type	Method and Description
OfferContent	getContent()
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf) This method must be overwritten by IQ subclasses to create their child content.
Map<String,List<String>>	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.
Jid	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.
Jid	getUserJID() The JID of the user that made the "join queue" request.

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

createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getChildElementXML, getType, initializeAsResultFor, initialzeAsResultFor, isRequestIQ, setType, toString, toXML

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

OfferRequestPacket

public OfferRequestPacket(Jid userJID,
                          Jid userID,
                          int timeout,
                          Map<String,List<String>> metaData,
                          String sessionID,
                          OfferContent content)

Method Detail

getUserID

public Jid 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 Jid 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<String,List<String>> getMetaData()

Returns any meta-data associated with the offer.

Returns:

meta-data associated with the offer.

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf)

Description copied from class: IQ

This method must be overwritten by IQ subclasses to create their child content. It is important you don't use the builder to add the final end tag. This will be done automatically by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements have been added.

For example to create an IQ with a extra attribute and an additional child element

 
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
 
 

the body of the getIQChildElementBuilder looks like

 
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
 
 

If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such.

 xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
 

If your IQ does not contain any attributes or child elements (besides ExtensionElements), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

buf - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.