Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.callback.events
Class EventInfo

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

public abstract class EventInfo
extends Message

Creates a callback "request for information" packet. Sent in response to a RequestGetInfo request.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventInfo create()
          Creates instance of EventInfo with no parameters set.
static EventInfo create(java.lang.String requestId, java.lang.String contact, MediaType mediaType, java.lang.Boolean done, java.lang.String startTime, java.lang.String endTime, java.lang.String status, KeyValueCollection userData)
          Creates instance of EventInfo with all parameters set.
abstract  java.lang.String getContact()
          A string providing contact information for a callback object.
abstract  java.lang.Boolean getDone()
          A boolean value, indicating whether the callback item has been marked as done.
abstract  java.lang.String getEndTime()
          A string that indicates the callback end time.
abstract  MediaType getMediaType()
          Specifies the media type for a callback object.
abstract  java.lang.Integer getReferenceId()
          An integer that provides a unique identifier for each request or event message.
abstract  java.lang.String getRequestId()
          This string identifies a particular request.
abstract  java.lang.String getStartTime()
          A string that indicates the callback start time.
abstract  java.lang.String getStatus()
          This string describes the current status of a callback request.
abstract  KeyValueCollection getUserData()
          A key value collection that contains user data.
abstract  void setContact(java.lang.String contact)
          A string providing contact information for a callback object.
abstract  void setDone(java.lang.Boolean done)
          A boolean value, indicating whether the callback item has been marked as done.
abstract  void setEndTime(java.lang.String endTime)
          A string that indicates the callback end time.
abstract  void setMediaType(MediaType mediaType)
          Specifies the media type for a callback object.
abstract  void setReferenceId(int referenceId)
          An integer that provides a unique identifier for each request or event message.
abstract  void setReferenceId(java.lang.Integer referenceId)
          An integer that provides a unique identifier for each request or event message.
abstract  void setRequestId(java.lang.String requestId)
          This string identifies a particular request.
abstract  void setStartTime(java.lang.String startTime)
          A string that indicates the callback start time.
abstract  void setStatus(java.lang.String status)
          This string describes the current status of a callback request.
abstract  void setUserData(KeyValueCollection userData)
          A key value collection that contains user data.
 
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 EventInfo create()
Creates instance of EventInfo with no parameters set.

Returns:
instance of EventInfo

create

public static EventInfo create(java.lang.String requestId,
                               java.lang.String contact,
                               MediaType mediaType,
                               java.lang.Boolean done,
                               java.lang.String startTime,
                               java.lang.String endTime,
                               java.lang.String status,
                               KeyValueCollection userData)
Creates instance of EventInfo with all parameters set.

Parameters:
requestId - RequestId
contact - Contact
mediaType - MediaType
done - Done
startTime - StartTime
endTime - EndTime
status - Status
userData - UserData
Returns:
instance of EventInfo

getReferenceId

public abstract java.lang.Integer getReferenceId()
An integer that provides a unique identifier for each request or event message.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
An integer that provides a unique identifier for each request or event message.


setReferenceId

public abstract void setReferenceId(int referenceId)
An integer that provides a unique identifier for each request or event message.


getRequestId

public abstract java.lang.String getRequestId()
This string identifies a particular request. When a related event is received, it will include the RequestId that you set.


setRequestId

public abstract void setRequestId(java.lang.String requestId)
This string identifies a particular request. When a related event is received, it will include the RequestId that you set.


getContact

public abstract java.lang.String getContact()
A string providing contact information for a callback object.


setContact

public abstract void setContact(java.lang.String contact)
A string providing contact information for a callback object.


getMediaType

public abstract MediaType getMediaType()
Specifies the media type for a callback object. Accepted values are: Voice or VoiceOverIP.


setMediaType

public abstract void setMediaType(MediaType mediaType)
Specifies the media type for a callback object. Accepted values are: Voice or VoiceOverIP.


getDone

public abstract java.lang.Boolean getDone()
A boolean value, indicating whether the callback item has been marked as done.


setDone

public abstract void setDone(java.lang.Boolean done)
A boolean value, indicating whether the callback item has been marked as done.


getStartTime

public abstract java.lang.String getStartTime()
A string that indicates the callback start time.


setStartTime

public abstract void setStartTime(java.lang.String startTime)
A string that indicates the callback start time.


getEndTime

public abstract java.lang.String getEndTime()
A string that indicates the callback end time.


setEndTime

public abstract void setEndTime(java.lang.String endTime)
A string that indicates the callback end time.


getStatus

public abstract java.lang.String getStatus()
This string describes the current status of a callback request.


setStatus

public abstract void setStatus(java.lang.String status)
This string describes the current status of a callback request.


getUserData

public abstract KeyValueCollection getUserData()
A key value collection that contains user data.


setUserData

public abstract void setUserData(KeyValueCollection userData)
A key value collection that contains user data.


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.