Package org.jivesoftware.smackx.workgroup

Class WorkgroupInvitation

java.lang.Object
org.jivesoftware.smackx.workgroup.WorkgroupInvitation
public class WorkgroupInvitation extends Object
An immutable class wrapping up the basic information which comprises a group chat invitation.

  • Field Details

    • uniqueID

      protected org.jxmpp.jid.Jid uniqueID

    • sessionID

      protected String sessionID

    • groupChatName

      protected org.jxmpp.jid.Jid groupChatName

    • issuingWorkgroupName

      protected org.jxmpp.jid.Jid issuingWorkgroupName

    • messageBody

      protected String messageBody

    • invitationSender

      protected org.jxmpp.jid.Jid invitationSender

    • metaData

      protected Map<String,List<String>> metaData

  • Constructor Details

    • WorkgroupInvitation

      public WorkgroupInvitation(org.jxmpp.jid.Jid jid, org.jxmpp.jid.Jid group, org.jxmpp.jid.Jid workgroup, String sessID, String msgBody, org.jxmpp.jid.Jid from)
      This calls the 5-argument constructor with a null MetaData argument value.
      Parameters:
      jid - the jid string with which the issuing AgentSession or Workgroup instance was created
      group - the jid of the room to which the person is invited
      workgroup - the jid of the workgroup issuing the invitation
      sessID - the session id associated with the pending chat
      msgBody - the body of the message which contained the invitation
      from - the user jid who issued the invitation, if known, null otherwise

    • WorkgroupInvitation

      public WorkgroupInvitation(org.jxmpp.jid.Jid jid, org.jxmpp.jid.Jid group, org.jxmpp.jid.Jid workgroup, String sessID, String msgBody, org.jxmpp.jid.Jid from, Map<String,List<String>> metaData)
      WorkgroupInvitation.
      Parameters:
      jid - the jid string with which the issuing AgentSession or Workgroup instance. was created
      group - the jid of the room to which the person is invited
      workgroup - the jid of the workgroup issuing the invitation
      sessID - the session id associated with the pending chat
      msgBody - the body of the message which contained the invitation
      from - the user jid who issued the invitation, if known, null otherwise
      metaData - the metadata sent with the invitation

  • Method Details

    • getUniqueID

      public org.jxmpp.jid.Jid getUniqueID()
      Get the unique id.
      Returns:
      the jid string with which the issuing AgentSession or Workgroup instance was created.

    • getSessionID

      public String getSessionID()
      Get the session id.
      Returns:
      the session id associated with the pending chat; working backwards temporally this session id should match the session id to the corresponding offer request which resulted in this invitation.

    • getGroupChatName

      public org.jxmpp.jid.Jid getGroupChatName()
      Get the group chat name.
      Returns:
      the jid of the room to which the person is invited.

    • getWorkgroupName

      public org.jxmpp.jid.Jid getWorkgroupName()
      Get workgroup name.
      Returns:
      the name of the workgroup from which the invitation was issued.

    • getMessageBody

      public String getMessageBody()
      Get the message body.
      Returns:
      the contents of the body-block of the message that housed this invitation.

    • getInvitationSender

      public org.jxmpp.jid.Jid getInvitationSender()
      Get invitation sender.
      Returns:
      the user who issued the invitation, or null if it wasn't known.

    • getMetaData

      public Map<String,List<String>> getMetaData()
      Get meta data.
      Returns:
      the meta data associated with the invitation, or null if this instance was constructed with none