Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.flexchat
Class EventInfo

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

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


Constructor Summary
EventInfo()
           
 
Method Summary
static EventInfo create()
          Creates instance of EventInfo with no parameters set.
static EventInfo create(java.lang.Integer partyId, EventType eventType, java.lang.String userNickname, UserType userType, java.lang.Integer timeOffset, java.lang.String messageType, java.lang.String text, NoticeType noticeType)
          Creates instance of EventInfo.
static EventInfo create(java.lang.Integer partyId, EventType eventType, java.lang.String userNickname, UserType userType, java.lang.Integer timeOffset, java.lang.String messageType, java.lang.String text, NoticeType noticeType, java.lang.Integer eventId)
          Creates instance of EventInfo.
abstract  java.lang.Integer getEventId()
           
abstract  EventType getEventType()
          The event type returned as part of an EventInfo object.
abstract  java.lang.String getMessageType()
          Defines the message type for each MessageText object.
abstract  MsgCheck getMsgCheck()
          Defines message checking information.
abstract  NoticeText getNoticeText()
           
abstract  NoticeType getNoticeType()
          Type of notification, as defined by the NoticeType enumeration.
abstract  java.lang.Integer getPartyId()
          An integer that represents a unique ID number for each party in the session.
abstract  java.lang.String getText()
          If NoticeType is not equal to None, then this property contains the notification text.
abstract  java.lang.Integer getTimeOffset()
          Number of seconds elapsed from the moment when chat session started.
abstract  KeyValueCollection getUserData()
          Pointer to the user data that should be attached to the interaction.
abstract  java.lang.String getUserNickname()
          The nickname of the chat user in the chat session.
abstract  UserType getUserType()
          The user type attached to the interaction.
abstract  void setEventId(int eventId)
           
abstract  void setEventId(java.lang.Integer eventId)
           
abstract  void setEventType(EventType eventType)
          The event type returned as part of an EventInfo object.
abstract  void setMessageType(java.lang.String messageType)
          Defines the message type for each MessageText object.
abstract  void setMsgCheck(MsgCheck msgCheck)
          Defines message checking information.
abstract  void setNoticeText(NoticeText noticeText)
           
abstract  void setNoticeType(NoticeType noticeType)
          Type of notification, as defined by the NoticeType enumeration.
abstract  void setPartyId(int partyId)
          An integer that represents a unique ID number for each party in the session.
abstract  void setPartyId(java.lang.Integer partyId)
          An integer that represents a unique ID number for each party in the session.
abstract  void setText(java.lang.String text)
          If NoticeType is not equal to None, then this property contains the notification text.
abstract  void setTimeOffset(int timeOffset)
          Number of seconds elapsed from the moment when chat session started.
abstract  void setTimeOffset(java.lang.Integer timeOffset)
          Number of seconds elapsed from the moment when chat session started.
abstract  void setUserData(KeyValueCollection userData)
          Pointer to the user data that should be attached to the interaction.
abstract  void setUserNickname(java.lang.String userNickname)
          The nickname of the chat user in the chat session.
abstract  void setUserType(UserType userType)
          The user type attached to the interaction.
 
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

EventInfo

public EventInfo()
Method Detail

create

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

Returns:
instance of EventInfo

create

public static EventInfo create(java.lang.Integer partyId,
                               EventType eventType,
                               java.lang.String userNickname,
                               UserType userType,
                               java.lang.Integer timeOffset,
                               java.lang.String messageType,
                               java.lang.String text,
                               NoticeType noticeType)
Creates instance of EventInfo.

Parameters:
partyId - PartyId
eventType - EventType
userNickname - UserNickname
userType - UserType
timeOffset - TimeOffset
messageType - MessageType
text - Text
noticeType - NoticeType
Returns:
instance of EventInfo

create

public static EventInfo create(java.lang.Integer partyId,
                               EventType eventType,
                               java.lang.String userNickname,
                               UserType userType,
                               java.lang.Integer timeOffset,
                               java.lang.String messageType,
                               java.lang.String text,
                               NoticeType noticeType,
                               java.lang.Integer eventId)
Creates instance of EventInfo.

Parameters:
partyId - PartyId
eventType - EventType
userNickname - UserNickname
userType - UserType
timeOffset - TimeOffset
messageType - MessageType
text - Text
noticeType - NoticeType
eventId - EventId
Returns:
instance of EventInfo

getPartyId

public abstract java.lang.Integer getPartyId()
An integer that represents a unique ID number for each party in the session. This ID is unique only within this particular chat session, not across different chat session.


setPartyId

public abstract void setPartyId(java.lang.Integer partyId)
An integer that represents a unique ID number for each party in the session. This ID is unique only within this particular chat session, not across different chat session.


setPartyId

public abstract void setPartyId(int partyId)
An integer that represents a unique ID number for each party in the session. This ID is unique only within this particular chat session, not across different chat session.


getEventType

public abstract EventType getEventType()
The event type returned as part of an EventInfo object. Valid values are:
Connect
Message
Abandon
Notice


setEventType

public abstract void setEventType(EventType eventType)
The event type returned as part of an EventInfo object. Valid values are:
Connect
Message
Abandon
Notice


getMsgCheck

public abstract MsgCheck getMsgCheck()
Defines message checking information.


setMsgCheck

public abstract void setMsgCheck(MsgCheck msgCheck)
Defines message checking information.


getUserNickname

public abstract java.lang.String getUserNickname()
The nickname of the chat user in the chat session.


setUserNickname

public abstract void setUserNickname(java.lang.String userNickname)
The nickname of the chat user in the chat session.


getUserType

public abstract UserType getUserType()
The user type attached to the interaction. Valid values are:
Client
Agent
Supervisor
External


setUserType

public abstract void setUserType(UserType userType)
The user type attached to the interaction. Valid values are:
Client
Agent
Supervisor
External


getTimeOffset

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


setTimeOffset

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


setTimeOffset

public abstract void setTimeOffset(int timeOffset)
Number of seconds elapsed from the moment when chat session started.


getMessageType

public abstract java.lang.String getMessageType()
Defines the message type for each MessageText object.


setMessageType

public abstract void setMessageType(java.lang.String messageType)
Defines the message type for each MessageText object.


getText

public abstract java.lang.String getText()
If NoticeType is not equal to None, then this property contains the notification text. Otherwise, it holds the message text.


setText

public abstract void setText(java.lang.String text)
If NoticeType is not equal to None, then this property contains the notification text. Otherwise, it holds the message text.


getNoticeType

public abstract NoticeType getNoticeType()
Type of notification, as defined by the NoticeType enumeration.


setNoticeType

public abstract void setNoticeType(NoticeType noticeType)
Type of notification, as defined by the NoticeType enumeration.


getEventId

public abstract java.lang.Integer getEventId()

setEventId

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

setEventId

public abstract void setEventId(int eventId)

getNoticeText

public abstract NoticeText getNoticeText()

setNoticeText

public abstract void setNoticeText(NoticeText noticeText)

getUserData

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


setUserData

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


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.