Package org.jivesoftware.smackx.workgroup.packet

Class AgentWorkgroups

java.lang.Object
org.jivesoftware.smack.packet.Stanza
org.jivesoftware.smack.packet.IQ
org.jivesoftware.smackx.workgroup.packet.AgentWorkgroups
All Implemented Interfaces:
Element, IqView, NamedElement, StanzaView, TopLevelStreamElement, XmlElement, XmlLangElement
public class AgentWorkgroups extends IQ
Represents a request for getting the jid of the workgroups where an agent can work or could represent the result of such request which will contain the list of workgroups JIDs where the agent can work.

  • Constructor Details

    • AgentWorkgroups

      public AgentWorkgroups(Jid agentJID)
      Creates an AgentWorkgroups request for the given agent. This IQ will be sent and an answer will be received with the jid of the workgroups where the agent can work.
      Parameters:
      agentJID - the id of the agent to get his workgroups.

    • AgentWorkgroups

      public AgentWorkgroups(Jid agentJID, List<String> workgroups)
      Creates an AgentWorkgroups which will contain the JIDs of the workgroups where an agent can work.
      Parameters:
      agentJID - the id of the agent that can work in the list of workgroups.
      workgroups - the list of workgroup JIDs where the agent can work.

  • Method Details

    • getAgentJID

      public Jid getAgentJID()

    • getWorkgroups

      public List<String> getWorkgroups()
      Returns a list of workgroup JIDs where the agent can work.
      Returns:
      a list of workgroup JIDs where the agent can work.

    • 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.