|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
com.genesyslab.platform.contacts.protocol.contactserver.requests.RequestUpdateInteraction
public final class RequestUpdateInteraction
This request is intended for updating of interaction attributes and binary content.
Required parameters:
Name | Description |
---|---|
setInteractionAttributes(com.genesyslab.platform.contacts.protocol.contactserver.InteractionAttributes) |
The list of Attributes and their values, which have to be updated. |
setEntityAttributes(com.genesyslab.platform.contacts.protocol.contactserver.BaseEntityAttributes) |
The list of Entity-specific attributes and their values, which have to be updated. |
Name | Description |
---|---|
EventUpdateInteraction |
This event indicates that the interaction attributes and binary content were updated correctly. |
EventError |
Indicates that the request encountered an error. |
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Fields inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage |
---|
REF_ID_KEY |
Constructor Summary | |
---|---|
RequestUpdateInteraction()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static RequestUpdateInteraction |
create()
|
com.genesyslab.platform.commons.protocol.runtime.DataSupport |
createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
|
boolean |
equals(java.lang.Object obj)
|
CoBrowseAction |
getAction()
Applicable to CoBrowse records. "Add": CoBrowseURL records are added to current records. "Replace": CoBrowseURL records replace current records. "Remove": CoBrowseURL records will be removed. |
java.util.Map |
getCompounds()
|
java.util.List |
getCustomPackagers()
|
BaseEntityAttributes |
getEntityAttributes()
The list of Entity specific attributes and their values, which have to be updated. Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction. |
InteractionAttributes |
getInteractionAttributes()
The list of attributes and their values, which have to be updated. If MediaServer specific parameters must be updated, then EntityTypeId is also required. Attributes which are declared as mandatory in RequestInsertInteraction description and attributes CanBeParent, CreatorAppId, StartDate must have a not null value if passed in UpdateInteraction. Id and TenantId are mandatory attributes. EntityTypeId is required if MediaServer specific parameters are updated. Id, TenantId, and EntityTypeId are immutable attributes. |
InteractionContent |
getInteractionContent()
Information to update binary content. Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction. |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
int |
hashCode()
|
void |
setAction(CoBrowseAction value)
Applicable to CoBrowse records. "Add": CoBrowseURL records are added to current records. "Replace": CoBrowseURL records replace current records. "Remove": CoBrowseURL records will be removed. |
void |
setEntityAttributes(BaseEntityAttributes value)
The list of Entity specific attributes and their values, which have to be updated. Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction. |
void |
setInteractionAttributes(InteractionAttributes value)
The list of attributes and their values, which have to be updated. If MediaServer specific parameters must be updated, then EntityTypeId is also required. Attributes which are declared as mandatory in RequestInsertInteraction description and attributes CanBeParent, CreatorAppId, StartDate must have a not null value if passed in UpdateInteraction. Id and TenantId are mandatory attributes. EntityTypeId is required if MediaServer specific parameters are updated. Id, TenantId, and EntityTypeId are immutable attributes. |
void |
setInteractionContent(InteractionContent value)
Information to update binary content. Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction. |
Methods inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage |
---|
getEndpoint, getLazyParser, getMessageAttribute, getProtocolId, getReferenceId, getRequestorInfo, retreiveReference, setEndpoint, setProtocolId, setReferenceId, setReferenceId, setRequestorInfo, toString, toString, toString, toString, updateReference |
Methods inherited from class com.genesyslab.platform.commons.protocol.Message |
---|
cloneMessage, getProtocolDescription, messageId, messageName, setProtocolDescription |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolDescriptionSupport |
---|
getProtocolDescription |
Field Detail |
---|
public static final int ID
public static final java.lang.String NAME
Constructor Detail |
---|
public RequestUpdateInteraction()
Method Detail |
---|
public static RequestUpdateInteraction create()
public InteractionAttributes getInteractionAttributes()
public void setInteractionAttributes(InteractionAttributes value)
public InteractionContent getInteractionContent()
public void setInteractionContent(InteractionContent value)
public BaseEntityAttributes getEntityAttributes()
public void setEntityAttributes(BaseEntityAttributes value)
public CoBrowseAction getAction()
public void setAction(CoBrowseAction value)
public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |