Package 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.IqView, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.StanzaView, org.jivesoftware.smack.packet.TopLevelStreamElement, org.jivesoftware.smack.packet.XmlElement, org.jivesoftware.smack.packet.XmlLangElement
public class Transcript extends org.jivesoftware.smack.packet.IQ
Represents the conversation transcript that occurred 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.ResponseType, 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
    Description
    Transcript(String sessionID)
    Creates a transcript request for the given sessionID.
    Transcript(String sessionID, 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
    Description
    protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder
    getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)
     
    List<org.jivesoftware.smack.packet.Stanza>
    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, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementQName, getChildElementXML, getElementName, getType, setType, toString, toXML

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

    addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, setError, setFrom, setNewStanzaId, setStanzaId, setTo, throwIfNoStanzaId

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.jivesoftware.smack.packet.Element

    toXML, toXML

    Methods inherited from interface org.jivesoftware.smack.packet.IqView

    isRequestIQ, isResponseIQ

    Methods inherited from interface org.jivesoftware.smack.packet.StanzaView

    getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension

    Methods inherited from interface org.jivesoftware.smack.packet.XmlElement

    getQName

  • Constructor Details

    • 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<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 Details

    • 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<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