Platform SDK Java 8.5 API Reference

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

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

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


Constructor Summary
NewPartyInfo()
           
 
Method Summary
static NewPartyInfo create()
          Creates instance of NewPartyInfo with no parameters set.
static NewPartyInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, KeyValueCollection userData, UserInfo userInfo, MessageText messageText)
          Creates instance of NewPartyInfo.
static NewPartyInfo create(java.lang.String userId, java.lang.Integer timeShift, Visibility visibility, KeyValueCollection userData, UserInfo userInfo, MessageText messageText, java.lang.Integer eventId)
          Creates instance of NewPartyInfo.
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  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  UserInfo getUserInfo()
           
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 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 setUserInfo(UserInfo userInfo)
           
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

NewPartyInfo

public NewPartyInfo()
Method Detail

create

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

Returns:
instance of NewPartyInfo

create

public static NewPartyInfo create(java.lang.String userId,
                                  java.lang.Integer timeShift,
                                  Visibility visibility,
                                  KeyValueCollection userData,
                                  UserInfo userInfo,
                                  MessageText messageText)
Creates instance of NewPartyInfo.

Parameters:
userId - UserId
timeShift - TimeShift
visibility - Visibility
userData - UserData
userInfo - UserInfo
messageText - MessageText
Returns:
instance of NewPartyInfo

create

public static NewPartyInfo create(java.lang.String userId,
                                  java.lang.Integer timeShift,
                                  Visibility visibility,
                                  KeyValueCollection userData,
                                  UserInfo userInfo,
                                  MessageText messageText,
                                  java.lang.Integer eventId)
Creates instance of NewPartyInfo.

Parameters:
userId - UserId
timeShift - TimeShift
visibility - Visibility
userData - UserData
userInfo - UserInfo
messageText - MessageText
eventId - EventId
Returns:
instance of NewPartyInfo

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


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.


getUserInfo

public abstract UserInfo getUserInfo()

setUserInfo

public abstract void setUserInfo(UserInfo userInfo)

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.