Package org.jivesoftware.smackx.workgroup.packet

Class OfferRequestProvider.OfferRequestPacket

  • All Implemented Interfaces:
    org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.FullyQualifiedElement, org.jivesoftware.smack.packet.IqView, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.StanzaView, org.jivesoftware.smack.packet.TopLevelStreamElement, org.jivesoftware.smack.packet.XmlLangElement
    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.ResponseType, org.jivesoftware.smack.packet.IQ.Type

    • Field Summary

      Fields 
      Modifier and Type Field 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 Description
      OfferRequestPacket​(org.jxmpp.jid.Jid userJID, org.jxmpp.jid.Jid userID, int timeout, java.util.Map<java.lang.String,​java.util.List<java.lang.String>> metaData, java.lang.String sessionID, OfferContent content)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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.
      org.jxmpp.jid.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.
      org.jxmpp.jid.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, getChildElementQName, getChildElementXML, getElementName, getType, isRequestIQ, isResponseIQ, setType, toString, toXML

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

        addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setLanguage, setNewStanzaId, setStanzaId, setStanzaId, setTo, throwIfNoStanzaId

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.jivesoftware.smack.packet.Element

        toXML, toXML

      • Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

        getQName

      • Methods inherited from interface org.jivesoftware.smack.packet.StanzaView

        getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension

    • Constructor Detail

      • OfferRequestPacket

        public OfferRequestPacket​(org.jxmpp.jid.Jid userJID,
                          org.jxmpp.jid.Jid 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 org.jxmpp.jid.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 org.jxmpp.jid.Jid 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).

      • 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