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:
Element, IqView, NamedElement, StanzaView, TopLevelStreamElement, XmlElement, XmlLangElement
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

  • Constructor Details

    • Transcripts

      public Transcripts(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(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 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 IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf)
      Description copied from class: IQ
      This method must be overwritten by IQ subclasses to create their child content. It is important you don't use the builder to add the final end tag. This will be done automatically by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements have been added.

      For example to create an IQ with a extra attribute and an additional child element 

       
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
      the body of the getIQChildElementBuilder looks like 
       
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
      If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such. 
       xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
      If your IQ does not contain any attributes or child elements (besides ExtensionElements), consider sub-classing SimpleIQ instead.
      Specified by:
      getIQChildElementBuilder in class IQ
      Parameters:
      buf - a pre-created builder which already has the child element and the 'xmlns' attribute set.
      Returns:
      the build to create the IQ child content.