Package org.jivesoftware.smackx.workgroup.packet

Class Transcripts

java.lang.Object
org.jivesoftware.smack.packet.Stanza
org.jivesoftware.smack.packet.IQ
org.jivesoftware.smackx.workgroup.packet.Transcripts
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 Transcripts extends org.jivesoftware.smack.packet.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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    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

    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
    Transcripts(org.jxmpp.jid.Jid userID)
    Creates a transcripts request for the given userID.
    Transcripts(org.jxmpp.jid.Jid userID, List<Transcripts.TranscriptSummary> summaries)
    Creates a Transcripts which will contain the transcript summaries of the given user.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder
    getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)
     
    List<Transcripts.TranscriptSummary>
    getSummaries()
    Returns a list of TranscriptSummary.
    org.jxmpp.jid.Jid
    getUserID()
    Returns the id of the user that was involved in the conversations.

    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

    • Transcripts

      public Transcripts(org.jxmpp.jid.Jid userID)
      Creates a transcripts request for the given userID.
      Parameters:
      userID - the id of the user to get his conversations transcripts.

    • Transcripts

      public Transcripts(org.jxmpp.jid.Jid 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 Details

    • getUserID

      public org.jxmpp.jid.Jid 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 identify 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.

    • 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