Class WorkgroupInvitation


  • public class WorkgroupInvitation
    extends java.lang.Object
    An immutable class wrapping up the basic information which comprises a group chat invitation.
    • Constructor Detail

      • WorkgroupInvitation

        public WorkgroupInvitation​(Jid jid,
                                   Jid group,
                                   Jid workgroup,
                                   java.lang.String sessID,
                                   java.lang.String msgBody,
                                   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​(Jid jid,
                                   Jid group,
                                   Jid workgroup,
                                   java.lang.String sessID,
                                   java.lang.String msgBody,
                                   Jid from,
                                   java.util.Map<java.lang.String,​java.util.List<java.lang.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 Detail

      • getUniqueID

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

        public java.lang.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 Jid getGroupChatName()
        Get the group chat name.
        Returns:
        the jid of the room to which the person is invited.
      • getWorkgroupName

        public Jid getWorkgroupName()
        Get workgroup name.
        Returns:
        the name of the workgroup from which the invitation was issued.
      • getMessageBody

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

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

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