Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat.events
Class EventSessionInfo

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.webmedia.protocol.basicchat.events.EventSessionInfo
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventSessionInfo
extends Message

This event provides transcript information about a chat session. An EventSessionInfo event provides a ChatTranscript object for a particular chat session, along with SessionStatus and OccurredAt details describing when the session information was returned and the current status of that chat session.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventSessionInfo create()
          Creates instance of EventSessionInfo with no parameters set.
static EventSessionInfo create(SessionStatus sessionStatus, java.lang.String occurredAt, ChatTranscript chatTranscript)
          Creates instance of EventSessionInfo with all parameters set.
abstract  ChatTranscript getChatTranscript()
           
abstract  java.lang.String getOccurredAt()
          Indicates when an event occurred.
abstract  java.lang.Integer getReferenceId()
          The unique reference ID for any requests or events.
abstract  SessionStatus getSessionStatus()
          Specifies the current status of a chat session.
abstract  void setChatTranscript(ChatTranscript chatTranscript)
           
abstract  void setOccurredAt(java.lang.String occurredAt)
          Indicates when an event occurred.
abstract  void setReferenceId(int referenceId)
          The unique reference ID for any requests or events.
abstract  void setReferenceId(java.lang.Integer referenceId)
          The unique reference ID for any requests or events.
abstract  void setSessionStatus(SessionStatus sessionStatus)
          Specifies the current status of a chat session.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
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
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

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

Returns:
instance of EventSessionInfo

create

public static EventSessionInfo create(SessionStatus sessionStatus,
                                      java.lang.String occurredAt,
                                      ChatTranscript chatTranscript)
Creates instance of EventSessionInfo with all parameters set.

Parameters:
sessionStatus - SessionStatus
occurredAt - OccurredAt
chatTranscript - ChatTranscript
Returns:
instance of EventSessionInfo

getReferenceId

public abstract java.lang.Integer getReferenceId()
The unique reference ID for any requests or events.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
The unique reference ID for any requests or events.


setReferenceId

public abstract void setReferenceId(int referenceId)
The unique reference ID for any requests or events.


getSessionStatus

public abstract SessionStatus getSessionStatus()
Specifies the current status of a chat session. Accepted values are: Alive and Over.


setSessionStatus

public abstract void setSessionStatus(SessionStatus sessionStatus)
Specifies the current status of a chat session. Accepted values are: Alive and Over.


getOccurredAt

public abstract java.lang.String getOccurredAt()
Indicates when an event occurred.


setOccurredAt

public abstract void setOccurredAt(java.lang.String occurredAt)
Indicates when an event occurred.


getChatTranscript

public abstract ChatTranscript getChatTranscript()

setChatTranscript

public abstract void setChatTranscript(ChatTranscript chatTranscript)

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.