Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat
Class ChatTranscript

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.runtime.CompoundValue
          extended by com.genesyslab.platform.webmedia.protocol.basicchat.ChatTranscript
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class ChatTranscript
extends com.genesyslab.platform.commons.protocol.runtime.CompoundValue


Constructor Summary
ChatTranscript()
           
 
Method Summary
static ChatTranscript create()
          Creates instance of ChatTranscript with no parameters set.
static ChatTranscript create(java.lang.String startAt, java.lang.String sessionId, BasicChatEventList chatEventList)
          Creates instance of ChatTranscript.
static ChatTranscript create(java.lang.String startAt, java.lang.String sessionId, BasicChatEventList chatEventList, java.lang.Integer savedPosition)
          Creates instance of ChatTranscript.
abstract  BasicChatEventList getChatEventList()
          Chat event list returned with an EventSessionInfo event.
abstract  java.lang.Integer getIdleTimeExpire()
           
abstract  java.lang.Boolean getMonitored()
           
abstract  java.lang.Integer getSavedPosition()
           
abstract  java.lang.String getSessionId()
          The unique session ID for chat sessions.
abstract  java.lang.String getStartAt()
          Starting time for a ChatTranscript object.
abstract  void setChatEventList(BasicChatEventList chatEventList)
          Chat event list returned with an EventSessionInfo event.
abstract  void setIdleTimeExpire(int idleTimeExpire)
           
abstract  void setIdleTimeExpire(java.lang.Integer idleTimeExpire)
           
abstract  void setMonitored(java.lang.Boolean monitored)
           
abstract  void setSavedPosition(int savedPosition)
           
abstract  void setSavedPosition(java.lang.Integer savedPosition)
           
abstract  void setSessionId(java.lang.String sessionId)
          The unique session ID for chat sessions.
abstract  void setStartAt(java.lang.String startAt)
          Starting time for a ChatTranscript object.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.runtime.CompoundValue
getProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ChatTranscript

public ChatTranscript()
Method Detail

create

public static ChatTranscript create()
Creates instance of ChatTranscript with no parameters set.

Returns:
instance of ChatTranscript

create

public static ChatTranscript create(java.lang.String startAt,
                                    java.lang.String sessionId,
                                    BasicChatEventList chatEventList)
Creates instance of ChatTranscript.

Parameters:
startAt - StartAt
sessionId - SessionId
chatEventList - ChatEventList
Returns:
instance of ChatTranscript

create

public static ChatTranscript create(java.lang.String startAt,
                                    java.lang.String sessionId,
                                    BasicChatEventList chatEventList,
                                    java.lang.Integer savedPosition)
Creates instance of ChatTranscript.

Parameters:
startAt - StartAt
sessionId - SessionId
chatEventList - ChatEventList
savedPosition - SavedPosition
Returns:
instance of ChatTranscript

getStartAt

public abstract java.lang.String getStartAt()
Starting time for a ChatTranscript object.


setStartAt

public abstract void setStartAt(java.lang.String startAt)
Starting time for a ChatTranscript object.


getSessionId

public abstract java.lang.String getSessionId()
The unique session ID for chat sessions. This property must be specified when a party joins (or is released from) an existing chat session. Leave this property empty when creating a new chat session.


setSessionId

public abstract void setSessionId(java.lang.String sessionId)
The unique session ID for chat sessions. This property must be specified when a party joins (or is released from) an existing chat session. Leave this property empty when creating a new chat session.


getChatEventList

public abstract BasicChatEventList getChatEventList()
Chat event list returned with an EventSessionInfo event.


setChatEventList

public abstract void setChatEventList(BasicChatEventList chatEventList)
Chat event list returned with an EventSessionInfo event.


getSavedPosition

public abstract java.lang.Integer getSavedPosition()

setSavedPosition

public abstract void setSavedPosition(java.lang.Integer savedPosition)

setSavedPosition

public abstract void setSavedPosition(int savedPosition)

getIdleTimeExpire

public abstract java.lang.Integer getIdleTimeExpire()

setIdleTimeExpire

public abstract void setIdleTimeExpire(java.lang.Integer idleTimeExpire)

setIdleTimeExpire

public abstract void setIdleTimeExpire(int idleTimeExpire)

getMonitored

public abstract java.lang.Boolean getMonitored()

setMonitored

public abstract void setMonitored(java.lang.Boolean monitored)

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.