Class AgentRoster


  • public class AgentRoster
    extends java.lang.Object
    Manges information about the agents in a workgroup and their presence.
    See Also:
    AgentSession.getAgentRoster()
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addListener​(AgentRosterListener listener)
      Adds a listener to this roster.
      boolean contains​(org.jxmpp.jid.Jid jid)
      Returns true if the specified XMPP address is an agent in the workgroup.
      int getAgentCount()
      Returns a count of all agents in the workgroup.
      java.util.Set<org.jxmpp.jid.EntityBareJid> getAgents()
      Returns all agents (String JID values) in the workgroup.
      org.jivesoftware.smack.packet.Presence getPresence​(org.jxmpp.jid.Jid user)
      Returns the presence info for a particular agent, or null if the agent is unavailable (offline) or if no presence information is available.
      void reload()
      Reloads the entire roster from the server.
      void removeListener​(AgentRosterListener listener)
      Removes a listener from this roster.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • reload

        public void reload()
                    throws org.jivesoftware.smack.SmackException.NotConnectedException,
                           java.lang.InterruptedException
        Reloads the entire roster from the server. This is an asynchronous operation, which means the method will return immediately, and the roster will be reloaded at a later point when the server responds to the reload request.
        Throws:
        org.jivesoftware.smack.SmackException.NotConnectedException - if the XMPP connection is not connected.
        java.lang.InterruptedException - if the calling thread was interrupted.
      • addListener

        public void addListener​(AgentRosterListener listener)
        Adds a listener to this roster. The listener will be fired anytime one or more changes to the roster are pushed from the server.
        Parameters:
        listener - an agent roster listener.
      • removeListener

        public void removeListener​(AgentRosterListener listener)
        Removes a listener from this roster. The listener will be fired anytime one or more changes to the roster are pushed from the server.
        Parameters:
        listener - a roster listener.
      • getAgentCount

        public int getAgentCount()
        Returns a count of all agents in the workgroup.
        Returns:
        the number of agents in the workgroup.
      • getAgents

        public java.util.Set<org.jxmpp.jid.EntityBareJid> getAgents()
        Returns all agents (String JID values) in the workgroup.
        Returns:
        all entries in the roster.
      • contains

        public boolean contains​(org.jxmpp.jid.Jid jid)
        Returns true if the specified XMPP address is an agent in the workgroup.
        Parameters:
        jid - the XMPP address of the agent (eg "jsmith@example.com"). The address can be in any valid format (e.g. "domain/resource", "user@domain" or "user@domain/resource").
        Returns:
        true if the XMPP address is an agent in the workgroup.
      • getPresence

        public org.jivesoftware.smack.packet.Presence getPresence​(org.jxmpp.jid.Jid user)
        Returns the presence info for a particular agent, or null if the agent is unavailable (offline) or if no presence information is available.

        Parameters:
        user - a fully qualified xmpp JID. The address could be in any valid format (e.g. "domain/resource", "user@domain" or "user@domain/resource").
        Returns:
        the agent's current presence, or null if the agent is unavailable or if no presence information is available..