Platform SDK Java 8.5 API Reference

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

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

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


Constructor Summary
MessageInfo()
           
 
Method Summary
static MessageInfo create()
          Creates instance of MessageInfo with no parameters set.
static MessageInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, MessageText messageText)
          Creates instance of MessageInfo.
static MessageInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, MessageText messageText, java.lang.Integer eventId, java.lang.String receiverId)
          Creates instance of MessageInfo.
abstract  java.lang.Integer getEventId()
           
abstract  MessageText getMessageText()
           
abstract  java.lang.String getReceiverId()
           
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 setEventId(int eventId)
           
abstract  void setEventId(java.lang.Integer eventId)
           
abstract  void setMessageText(MessageText messageText)
           
abstract  void setReceiverId(java.lang.String receiverId)
           
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

MessageInfo

public MessageInfo()
Method Detail

create

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

Returns:
instance of MessageInfo

create

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

Parameters:
userId - UserId
timeShift - TimeShift
visibility - Visibility
messageText - MessageText
Returns:
instance of MessageInfo

create

public static MessageInfo create(java.lang.String userId,
                                 java.lang.Integer timeShift,
                                 Visibility visibility,
                                 MessageText messageText,
                                 java.lang.Integer eventId,
                                 java.lang.String receiverId)
Creates instance of MessageInfo.

Parameters:
userId - UserId
timeShift - TimeShift
visibility - Visibility
messageText - MessageText
eventId - EventId
receiverId - ReceiverId
Returns:
instance of MessageInfo

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).


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)

getReceiverId

public abstract java.lang.String getReceiverId()

setReceiverId

public abstract void setReceiverId(java.lang.String receiverId)

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.