Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.email.requests
Class RequestSubmit

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

public abstract class RequestSubmit
extends Message

Issues a request to submit an e-mail interaction. To create a new RequestSubmit message, you need to set values for the MediaType and UserData.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestSubmit create()
          Creates instance of RequestSubmit with no parameters set.
static RequestSubmit create(java.lang.String mediaType, EmailProperties userData)
          Creates instance of RequestSubmit with all parameters set.
abstract  java.lang.String getMediaType()
          Specifies the media type for an e-mail object.
abstract  java.lang.Integer getReferenceId()
          An integer that provides a unique identifier for each request or event message.
abstract  EmailProperties getUserData()
          A key value collection that contains user data.
abstract  void setMediaType(java.lang.String mediaType)
          Specifies the media type for an e-mail 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 setUserData(EmailProperties 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 RequestSubmit create()
Creates instance of RequestSubmit with no parameters set.

Returns:
instance of RequestSubmit

create

public static RequestSubmit create(java.lang.String mediaType,
                                   EmailProperties userData)
Creates instance of RequestSubmit with all parameters set.

Parameters:
mediaType - MediaType
userData - UserData
Returns:
instance of RequestSubmit

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.


getMediaType

public abstract java.lang.String getMediaType()
Specifies the media type for an e-mail object.


setMediaType

public abstract void setMediaType(java.lang.String mediaType)
Specifies the media type for an e-mail object.


getUserData

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


setUserData

public abstract void setUserData(EmailProperties 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.