Smack

org.jivesoftware.smackx.workgroup
Class WorkgroupInvitation

java.lang.Object
  extended by org.jivesoftware.smackx.workgroup.WorkgroupInvitation

public class WorkgroupInvitation
extends Object

An immutable class wrapping up the basic information which comprises a group chat invitation.

Author:
loki der quaeler

Field Summary
protected  String groupChatName
           
protected  String invitationSender
           
protected  String issuingWorkgroupName
           
protected  String messageBody
           
protected  Map<String,List<String>> metaData
           
protected  String sessionID
           
protected  String uniqueID
           
 
Constructor Summary
WorkgroupInvitation(String jid, String group, String workgroup, String sessID, String msgBody, String from)
          This calls the 5-argument constructor with a null MetaData argument value
WorkgroupInvitation(String jid, String group, String workgroup, String sessID, String msgBody, String from, Map<String,List<String>> metaData)
           
 
Method Summary
 String getGroupChatName()
           
 String getInvitationSender()
           
 String getMessageBody()
           
 Map<String,List<String>> getMetaData()
           
 String getSessionID()
           
 String getUniqueID()
           
 String getWorkgroupName()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

uniqueID

protected String uniqueID

sessionID

protected String sessionID

groupChatName

protected String groupChatName

issuingWorkgroupName

protected String issuingWorkgroupName

messageBody

protected String messageBody

invitationSender

protected String invitationSender

metaData

protected Map<String,List<String>> metaData
Constructor Detail

WorkgroupInvitation

public WorkgroupInvitation(String jid,
                           String group,
                           String workgroup,
                           String sessID,
                           String msgBody,
                           String 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(String jid,
                           String group,
                           String workgroup,
                           String sessID,
                           String msgBody,
                           String from,
                           Map<String,List<String>> metaData)
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 String getUniqueID()
Returns:
the jid string with which the issuing AgentSession or Workgroup instance was created.

getSessionID

public String getSessionID()
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 String getGroupChatName()
Returns:
the jid of the room to which the person is invited.

getWorkgroupName

public String getWorkgroupName()
Returns:
the name of the workgroup from which the invitation was issued.

getMessageBody

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

getInvitationSender

public String getInvitationSender()
Returns:
the user who issued the invitation, or null if it wasn't known.

getMetaData

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

Smack

Copyright © 2003-2007 Jive Software.