Class QueueDetails

  • All Implemented Interfaces:
    org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.ExtensionElement, org.jivesoftware.smack.packet.FullyQualifiedElement, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.XmlLangElement

    public final class QueueDetails
    extends java.lang.Object
    implements org.jivesoftware.smack.packet.ExtensionElement
    Queue details stanza extension, which contains details about the users currently in a queue.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  QueueDetails.Provider
      Provider class for QueueDetails stanza extensions.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELEMENT_NAME
      Element name of the stanza extension.
      static java.lang.String NAMESPACE
      Namespace of the stanza extension.
    • Constructor Summary

      Constructors 
      Constructor Description
      QueueDetails()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getElementName()  
      java.lang.String getNamespace()  
      int getUserCount()
      Returns the number of users currently in the queue that are waiting to be routed to an agent.
      java.util.Set<QueueUser> getUsers()
      Returns the set of users in the queue that are waiting to be routed to an agent (as QueueUser objects).
      java.lang.String toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface org.jivesoftware.smack.packet.Element

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

        getLanguage, getQName
    • Field Detail

      • ELEMENT_NAME

        public static final java.lang.String ELEMENT_NAME
        Element name of the stanza extension.
        See Also:
        Constant Field Values
      • NAMESPACE

        public static final java.lang.String NAMESPACE
        Namespace of the stanza extension.
        See Also:
        Constant Field Values
    • Constructor Detail

      • QueueDetails

        public QueueDetails()
    • Method Detail

      • getUserCount

        public int getUserCount()
        Returns the number of users currently in the queue that are waiting to be routed to an agent.
        Returns:
        the number of users in the queue.
      • getUsers

        public java.util.Set<QueueUser> getUsers()
        Returns the set of users in the queue that are waiting to be routed to an agent (as QueueUser objects).
        Returns:
        a Set for the users waiting in a queue.
      • getElementName

        public java.lang.String getElementName()
        Specified by:
        getElementName in interface org.jivesoftware.smack.packet.NamedElement
      • getNamespace

        public java.lang.String getNamespace()
        Specified by:
        getNamespace in interface org.jivesoftware.smack.packet.FullyQualifiedElement
      • toXML

        public java.lang.String toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
        Specified by:
        toXML in interface org.jivesoftware.smack.packet.Element