org.jivesoftware.smackx.workgroup.packet

Class Transcript

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.workgroup.packet.Transcript

public class Transcript
extends IQ

Represents the conversation transcript that occured in a group chat room between an Agent and a user that requested assistance. The transcript contains all the Messages that were sent to the room as well as the sent presences.

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.Type

Field Summary

Fields inherited from class org.jivesoftware.smack.packet.Packet

DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
Transcript(String sessionID) Creates a transcript request for the given sessionID.
Transcript(String sessionID, List<Packet> packets) Creates a new transcript for the given sessionID and list of packets.

Method Summary

Methods

Modifier and Type	Method and Description
String	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
List<Packet>	getPackets() Returns the list of Messages and Presences that were sent to the room.
String	getSessionID() Returns id of the session that generated this conversation transcript.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getType, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Packet

addCommonAttributes, addExtension, addExtensions, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Transcript

public Transcript(String sessionID)

Creates a transcript request for the given sessionID.

Parameters:

sessionID - the id of the session to get the conversation transcript.

Transcript

public Transcript(String sessionID,
          List<Packet> packets)

Creates a new transcript for the given sessionID and list of packets. The list of packets may include Messages and/or Presences.

Parameters:

sessionID - the id of the session that generated this conversation transcript.

packets - the list of messages and presences send to the room.

Method Detail

getSessionID

public String getSessionID()

Returns id of the session that generated this conversation transcript. The sessionID is a value generated by the server when a new request is received.

Returns:

id of the session that generated this conversation transcript.

getPackets

public List<Packet> getPackets()

Returns the list of Messages and Presences that were sent to the room.

Returns:

the list of Messages and Presences that were sent to the room.

getChildElementXML

public String getChildElementXML()

Description copied from class: IQ

Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Specified by:

getChildElementXML in class IQ

Returns:

the child element section of the IQ XML.