Platform SDK Java 8.5 API Reference

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

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

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


Constructor Summary
NoticeInfo()
           
 
Method Summary
static NoticeInfo create()
          Creates instance of NoticeInfo with no parameters set.
static NoticeInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, NoticeText noticeText, MessageText messageText, KeyValueCollection userData)
          Creates instance of NoticeInfo.
static NoticeInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, NoticeText noticeText, MessageText messageText, KeyValueCollection userData, java.lang.Integer eventId, java.lang.String receiverId)
          Creates instance of NoticeInfo.
abstract  java.lang.Integer getEventId()
           
abstract  MessageText getMessageText()
           
abstract  NoticeText getNoticeText()
           
abstract  java.lang.String getReceiverId()
           
abstract  java.lang.Integer getTimeShift()
          Number of seconds elapsed from the moment when chat session started
abstract  KeyValueCollection getUserData()
          Pointer to the user data attached to the interaction.
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 setNoticeText(NoticeText noticeText)
           
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 setUserData(KeyValueCollection userData)
          Pointer to the user data attached to the interaction.
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

NoticeInfo

public NoticeInfo()
Method Detail

create

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

Returns:
instance of NoticeInfo

create

public static NoticeInfo create(java.lang.String userId,
                                java.lang.Integer timeShift,
                                Visibility visibility,
                                NoticeText noticeText,
                                MessageText messageText,
                                KeyValueCollection userData)
Creates instance of NoticeInfo.

Parameters:
userId - UserId
timeShift - TimeShift
visibility - Visibility
noticeText - NoticeText
messageText - MessageText
userData - UserData
Returns:
instance of NoticeInfo

create

public static NoticeInfo create(java.lang.String userId,
                                java.lang.Integer timeShift,
                                Visibility visibility,
                                NoticeText noticeText,
                                MessageText messageText,
                                KeyValueCollection userData,
                                java.lang.Integer eventId,
                                java.lang.String receiverId)
Creates instance of NoticeInfo.

Parameters:
userId - UserId
timeShift - TimeShift
visibility - Visibility
noticeText - NoticeText
messageText - MessageText
userData - UserData
eventId - EventId
receiverId - ReceiverId
Returns:
instance of NoticeInfo

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


getNoticeText

public abstract NoticeText getNoticeText()

setNoticeText

public abstract void setNoticeText(NoticeText noticeText)

getMessageText

public abstract MessageText getMessageText()

setMessageText

public abstract void setMessageText(MessageText messageText)

getUserData

public abstract KeyValueCollection getUserData()
Pointer to the user data attached to the interaction.


setUserData

public abstract void setUserData(KeyValueCollection userData)
Pointer to the user data attached to the interaction.


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.