Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat.requests
Class RequestNotify

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

public abstract class RequestNotify
extends Message

Issues a request to add a notice (that is, a notification) to the current chat session. To create a RequestNotify request, you need to set correct values for SessionID, NoticeText, and Visibility. (Additionally, NoticeType must not be set to None.)


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestNotify create()
          Creates instance of RequestNotify with no parameters set.
static RequestNotify create(java.lang.String sessionId, Visibility visibility)
          Creates instance of RequestNotify.
static RequestNotify create(java.lang.String sessionId, Visibility visibility, NoticeText noticeText, MessageText messageText, KeyValueCollection userData)
          Creates instance of RequestNotify.
abstract  MessageText getMessageText()
           
abstract  NoticeText getNoticeText()
           
abstract  java.lang.String getReceiverId()
           
abstract  java.lang.Integer getReferenceId()
          The unique reference ID for any requests or events.
abstract  java.lang.String getSessionId()
          The unique session ID for chat sessions.
abstract  KeyValueCollection getUserData()
          Pointer to the user data attached to the interaction.
abstract  Visibility getVisibility()
          This value determines the visibility of this event for other participants of chat session.
abstract  void setMessageText(MessageText messageText)
           
abstract  void setNoticeText(NoticeText noticeText)
           
abstract  void setReceiverId(java.lang.String receiverId)
           
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 setSessionId(java.lang.String sessionId)
          The unique session ID for chat sessions.
abstract  void setUserData(KeyValueCollection userData)
          Pointer to the user data attached to the interaction.
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.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 RequestNotify create()
Creates instance of RequestNotify with no parameters set.

Returns:
instance of RequestNotify

create

public static RequestNotify create(java.lang.String sessionId,
                                   Visibility visibility)
Creates instance of RequestNotify.

Parameters:
sessionId - SessionId
visibility - Visibility
Returns:
instance of RequestNotify

create

public static RequestNotify create(java.lang.String sessionId,
                                   Visibility visibility,
                                   NoticeText noticeText,
                                   MessageText messageText,
                                   KeyValueCollection userData)
Creates instance of RequestNotify.

Parameters:
sessionId - SessionId
visibility - Visibility
noticeText - NoticeText
messageText - MessageText
userData - UserData
Returns:
instance of RequestNotify

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.


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.


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.


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.