Class QueueUpdate

  • 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 class QueueUpdate
    extends java.lang.Object
    implements org.jivesoftware.smack.packet.ExtensionElement
    An IQ stanza that encapsulates both types of workgroup queue status notifications -- position updates, and estimated time left in the queue updates.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  QueueUpdate.Provider  
    • 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
      QueueUpdate​(int position, int remainingTime)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getElementName()  
      java.lang.String getNamespace()  
      int getPosition()
      Returns the user's position in the workgroup queue, or -1 if the value isn't set on this packet.
      int getRemaingTime()
      Returns the user's estimated time left in the workgroup queue, or -1 if the value isn't set on this packet.
      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

      • QueueUpdate

        public QueueUpdate​(int position,
                           int remainingTime)
    • Method Detail

      • getPosition

        public int getPosition()
        Returns the user's position in the workgroup queue, or -1 if the value isn't set on this packet.
        Returns:
        the position in the workgroup queue.
      • getRemaingTime

        public int getRemaingTime()
        Returns the user's estimated time left in the workgroup queue, or -1 if the value isn't set on this packet.
        Returns:
        the estimated time left in the workgroup queue.
      • toXML

        public java.lang.String toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
        Specified by:
        toXML in interface org.jivesoftware.smack.packet.Element
      • 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