org.jivesoftware.smackx.workgroup.packet

Class Transcript

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.workgroup.packet.Transcript

All Implemented Interfaces:

org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.Packet, org.jivesoftware.smack.packet.TopLevelStreamElement

public class Transcript
extends org.jivesoftware.smack.packet.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

org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder, org.jivesoftware.smack.packet.IQ.Type

Field Summary

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

IQ_ELEMENT, QUERY_ELEMENT

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

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor and Description
Transcript(java.lang.String sessionID) Creates a transcript request for the given sessionID.
Transcript(java.lang.String sessionID, java.util.List<org.jivesoftware.smack.packet.Stanza> packets) Creates a new transcript for the given sessionID and list of packets.

Method Summary

Modifier and Type	Method and Description
protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)
java.util.List<org.jivesoftware.smack.packet.Stanza>	getPackets() Returns the list of Messages and Presences that were sent to the room.
java.lang.String	getSessionID() Returns id of the session that generated this conversation transcript.

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

createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getType, isRequestIQ, setType, toXML

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, overrideExtension, removeExtension, removeExtension, setError, setFrom, setLanguage, setPacketID, setStanzaId, setTo, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Transcript

public Transcript(java.lang.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(java.lang.String sessionID,
                  java.util.List<org.jivesoftware.smack.packet.Stanza> 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 java.lang.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 java.util.List<org.jivesoftware.smack.packet.Stanza> 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.

getIQChildElementBuilder

protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)

Specified by:

getIQChildElementBuilder in class org.jivesoftware.smack.packet.IQ