QueueDetails

java.lang.Object

org.jivesoftware.smackx.workgroup.packet.QueueDetails

All Implemented Interfaces:: Element, ExtensionElement, NamedElement, XmlElement, XmlLangElement

public final class QueueDetails extends Object implements 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 final String

ELEMENT_NAME

Element name of the stanza extension.

static final String

NAMESPACE

Namespace of the stanza extension.

static final QName

QNAME
Constructor Summary

Constructors

Constructor

Description

QueueDetails()
Method Summary

Modifier and Type

Method

Description

String

getElementName()

Returns the root element name.

String

getNamespace()

Returns the root element XML namespace.

int

getUserCount()

Returns the number of users currently in the queue that are waiting to be routed to an agent.

Set<QueueUser>

getUsers()

Returns the set of users in the queue that are waiting to be routed to an agent (as QueueUser objects).

String

toXML(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.XmlElement
getLanguage, getQName

Field Details
- ELEMENT_NAME
  
  public static final String ELEMENT_NAME
  
  Element name of the stanza extension.
  See Also:
  
  Constant Field Values
- NAMESPACE
  
  public static final String NAMESPACE
  
  Namespace of the stanza extension.
  See Also:
  
  Constant Field Values
- QNAME
  
  public static final QName QNAME
Constructor Details
- QueueDetails
  
  public QueueDetails()
Method Details
- 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 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 String getElementName()
  
  Description copied from interface: NamedElement
  
  Returns the root element name.
  
  Specified by:
  
  getElementName in interface NamedElement
  
  Returns:
  
  the element name.
- getNamespace
  
  public String getNamespace()
  
  Description copied from interface: XmlElement
  
  Returns the root element XML namespace.
  
  Specified by:
  
  getNamespace in interface XmlElement
  
  Returns:
  
  the namespace.
- toXML
  
  public String toXML(XmlEnvironment enclosingNamespace)
  
  Specified by:
  
  toXML in interface Element