org.jivesoftware.smackx.workgroup

Class WorkgroupInvitation

java.lang.Object

org.jivesoftware.smackx.workgroup.WorkgroupInvitation

public class WorkgroupInvitation
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	groupChatName
protected java.lang.String	invitationSender
protected java.lang.String	issuingWorkgroupName
protected java.lang.String	messageBody
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	metaData
protected java.lang.String	sessionID
protected java.lang.String	uniqueID

Constructor Summary

Constructors

Constructor and Description
WorkgroupInvitation(java.lang.String jid, java.lang.String group, java.lang.String workgroup, java.lang.String sessID, java.lang.String msgBody, java.lang.String from) This calls the 5-argument constructor with a null MetaData argument value
WorkgroupInvitation(java.lang.String jid, java.lang.String group, java.lang.String workgroup, java.lang.String sessID, java.lang.String msgBody, java.lang.String from, java.util.Map<java.lang.String,java.util.List<java.lang.String>> metaData)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getGroupChatName()
java.lang.String	getInvitationSender()
java.lang.String	getMessageBody()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getMetaData()
java.lang.String	getSessionID()
java.lang.String	getUniqueID()
java.lang.String	getWorkgroupName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uniqueID

protected java.lang.String uniqueID

sessionID

protected java.lang.String sessionID

groupChatName

protected java.lang.String groupChatName

issuingWorkgroupName

protected java.lang.String issuingWorkgroupName

messageBody

protected java.lang.String messageBody

invitationSender

protected java.lang.String invitationSender

metaData

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> metaData

Constructor Detail

WorkgroupInvitation

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

Returns:

the jid string with which the issuing AgentSession or Workgroup instance was created.

getSessionID

public java.lang.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 java.lang.String getGroupChatName()

Returns:

the jid of the room to which the person is invited.

getWorkgroupName

public java.lang.String getWorkgroupName()

Returns:

the name of the workgroup from which the invitation was issued.

getMessageBody

public java.lang.String getMessageBody()

Returns:

the contents of the body-block of the message that housed this invitation.

getInvitationSender

public java.lang.String getInvitationSender()

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()

Returns:

the meta data associated with the invitation, or null if this instance was constructed with none