org.jivesoftware.smackx.workgroup.packet
Class Transcripts

java.lang.Object
  org.jivesoftware.smack.packet.Packet
      org.jivesoftware.smack.packet.IQ
          org.jivesoftware.smackx.workgroup.packet.Transcripts

public class Transcripts
extends IQ

Represents a list of conversation transcripts that a user had in all his history. Each transcript summary includes the sessionID which may be used for getting more detailed information about the conversation. Transcript

Author:

Gaston Dombiak

Nested Class Summary

static class	Transcripts.AgentDetail An AgentDetail contains information of an Agent that was involved in a conversation.
static class	Transcripts.TranscriptSummary A TranscriptSummary contains some information about a conversation such as the ID of the session or the date when the conversation started and finished.

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

Transcripts(String userID)
Creates a transcripts request for the given userID.

Transcripts(String userID, List<Transcripts.TranscriptSummary> summaries)
Creates a Transcripts which will contain the transcript summaries of the given user.

Method Summary

String	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
List<Transcripts.TranscriptSummary>	getSummaries() Returns a list of TranscriptSummary.
String	getUserID() Returns the id of the user that was involved in the conversations.

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

getType, setType, toXML

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

addExtension, deleteProperty, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, parseXMLLang, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo

Methods inherited from class java.lang.Object

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

Constructor Detail

Transcripts

public Transcripts(String userID)

Creates a transcripts request for the given userID.

Parameters:

userID - the id of the user to get his conversations transcripts.

Transcripts

public Transcripts(String userID,
                   List<Transcripts.TranscriptSummary> summaries)

Creates a Transcripts which will contain the transcript summaries of the given user.

Parameters:

userID - the id of the user. Could be a real JID or a unique String that identifies anonymous users.

summaries - the list of TranscriptSummaries.

Method Detail

getUserID

public String getUserID()

Returns the id of the user that was involved in the conversations. The userID could be a real JID if the connected user was not anonymous. Otherwise, the userID will be a String that was provided by the anonymous user as a way to idenitify the user across many user sessions.

Returns:

the id of the user that was involved in the conversations.

getSummaries

public List<Transcripts.TranscriptSummary> getSummaries()

Returns a list of TranscriptSummary. A TranscriptSummary does not contain the conversation transcript but some summary information like the sessionID and the time when the conversation started and finished. Once you have the sessionID it is possible to get the full conversation transcript.

Returns:

a list of TranscriptSummary.

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.