Platform SDK Java 8.5 API Reference

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

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.ReenterInfo
All Implemented Interfaces:
ProtocolDescriptionSupport

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


Constructor Summary
ReenterInfo()
           
 
Method Summary
static ReenterInfo create()
          Creates instance of ReenterInfo with no parameters set.
static ReenterInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, UserStatus agents, UserStatus clients, MessageText messageText)
          Creates instance of ReenterInfo.
static ReenterInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, UserStatus agents, UserStatus clients, MessageText messageText, java.lang.Integer eventId)
          Creates instance of ReenterInfo.
abstract  UserStatus getAgents()
          Specifies the agent user status when a party re-enters the chat session.
abstract  UserStatus getClients()
          Specifies client user status.
abstract  java.lang.Integer getEventId()
           
abstract  MessageText getMessageText()
           
abstract  java.lang.Integer getTimeShift()
          Number of seconds elapsed from the moment when chat session started
abstract  java.lang.String getUserId()
          The user ID uniquely identifies chat party/user across all chat sessions.
abstract  Visibility getVisibility()
          This value determines the visibility of this event for other participants of chat session.
abstract  void setAgents(UserStatus agents)
          Specifies the agent user status when a party re-enters the chat session.
abstract  void setClients(UserStatus clients)
          Specifies client user status.
abstract  void setEventId(int eventId)
           
abstract  void setEventId(java.lang.Integer eventId)
           
abstract  void setMessageText(MessageText messageText)
           
abstract  void setTimeShift(int timeShift)
          Number of seconds elapsed from the moment when chat session started
abstract  void setTimeShift(java.lang.Integer timeShift)
          Number of seconds elapsed from the moment when chat session started
abstract  void setUserId(java.lang.String userId)
          The user ID uniquely identifies chat party/user across all chat sessions.
abstract  void setVisibility(Visibility visibility)
          This value determines the visibility of this event for other participants of chat session.
 
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

ReenterInfo

public ReenterInfo()
Method Detail

create

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

Returns:
instance of ReenterInfo

create

public static ReenterInfo create(java.lang.String userId,
                                 java.lang.Integer timeShift,
                                 Visibility visibility,
                                 UserStatus agents,
                                 UserStatus clients,
                                 MessageText messageText)
Creates instance of ReenterInfo.

Parameters:
userId - UserId
timeShift - TimeShift
visibility - Visibility
agents - Agents
clients - Clients
messageText - MessageText
Returns:
instance of ReenterInfo

create

public static ReenterInfo create(java.lang.String userId,
                                 java.lang.Integer timeShift,
                                 Visibility visibility,
                                 UserStatus agents,
                                 UserStatus clients,
                                 MessageText messageText,
                                 java.lang.Integer eventId)
Creates instance of ReenterInfo.

Parameters:
userId - UserId
timeShift - TimeShift
visibility - Visibility
agents - Agents
clients - Clients
messageText - MessageText
eventId - EventId
Returns:
instance of ReenterInfo

getUserId

public abstract java.lang.String getUserId()
The user ID uniquely identifies chat party/user across all chat sessions.


setUserId

public abstract void setUserId(java.lang.String userId)
The user ID uniquely identifies chat party/user across all chat sessions.


getTimeShift

public abstract java.lang.Integer getTimeShift()
Number of seconds elapsed from the moment when chat session started


setTimeShift

public abstract void setTimeShift(java.lang.Integer timeShift)
Number of seconds elapsed from the moment when chat session started


setTimeShift

public abstract void setTimeShift(int timeShift)
Number of seconds elapsed from the moment when chat session started


getVisibility

public abstract Visibility getVisibility()
This value determines the visibility of this event for other participants of chat session. Accepted values are: All (visible for all participants), Int (visible only for agents and supervisors), Vip (visible only for supervisors).


setVisibility

public abstract void setVisibility(Visibility visibility)
This value determines the visibility of this event for other participants of chat session. Accepted values are: All (visible for all participants), Int (visible only for agents and supervisors), Vip (visible only for supervisors).


getAgents

public abstract UserStatus getAgents()
Specifies the agent user status when a party re-enters the chat session. Accepted values are: On, Off, and Keep.


setAgents

public abstract void setAgents(UserStatus agents)
Specifies the agent user status when a party re-enters the chat session. Accepted values are: On, Off, and Keep.


getClients

public abstract UserStatus getClients()
Specifies client user status. Used when a party re-enters the chat session.


setClients

public abstract void setClients(UserStatus clients)
Specifies client user status. Used when a party re-enters the chat session.


getMessageText

public abstract MessageText getMessageText()

setMessageText

public abstract void setMessageText(MessageText messageText)

getEventId

public abstract java.lang.Integer getEventId()

setEventId

public abstract void setEventId(java.lang.Integer eventId)

setEventId

public abstract void setEventId(int eventId)

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.