|
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.openmedia.protocol.interactionserver.requests.interactionmanagement.RequestWorkbinNotifications
public abstract class RequestWorkbinNotifications
With this request, an agent application can subscribe to be notified of changes
to the content of a specified workbin. The request applies to place or agent workbins
only, not to agent group or place group workbins.
Direction: From agent application to Interaction Server
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestWorkbinNotifications |
create()
Creates instance of RequestWorkbinNotifications with no parameters set. |
static RequestWorkbinNotifications |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
WorkbinInfo workbin,
ReasonInfo reason,
java.lang.Integer notifyPropertyChanges)
Creates instance of RequestWorkbinNotifications. |
static RequestWorkbinNotifications |
create(WorkbinInfo workbin,
ReasonInfo reason)
Creates instance of RequestWorkbinNotifications. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.Integer |
getIdsOnlyInTakenOutNotification()
If present and has value not equal to 0, Interaction Server would report interaction ids only for interactions moved out of the workbin in EventWorkbinContentChanged when distributing to the corresponding client. |
abstract java.lang.Integer |
getNotifyPropertyChanges()
Default value 0 (false). |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract ReasonInfo |
getReason()
This property has been deprecated in all events. |
abstract java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
abstract java.lang.Integer |
getTenantId()
[Optional] Tenant identifier of the agent. |
abstract WorkbinInfo |
getWorkbin()
|
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setIdsOnlyInTakenOutNotification(int idsOnlyInTakenOutNotification)
If present and has value not equal to 0, Interaction Server would report interaction ids only for interactions moved out of the workbin in EventWorkbinContentChanged when distributing to the corresponding client. |
abstract void |
setIdsOnlyInTakenOutNotification(java.lang.Integer idsOnlyInTakenOutNotification)
If present and has value not equal to 0, Interaction Server would report interaction ids only for interactions moved out of the workbin in EventWorkbinContentChanged when distributing to the corresponding client. |
abstract void |
setNotifyPropertyChanges(int notifyPropertyChanges)
Default value 0 (false). |
abstract void |
setNotifyPropertyChanges(java.lang.Integer notifyPropertyChanges)
Default value 0 (false). |
abstract void |
setProxyClientId(int proxyClientId)
Proxy client identifier. |
abstract void |
setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. |
abstract void |
setReason(ReasonInfo reason)
This property has been deprecated in all events. |
abstract void |
setReferenceId(int referenceId)
Reference identifier of the request. |
abstract void |
setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. |
abstract void |
setTenantId(int tenantId)
[Optional] Tenant identifier of the agent. |
abstract void |
setTenantId(java.lang.Integer tenantId)
[Optional] Tenant identifier of the agent. |
abstract void |
setWorkbin(WorkbinInfo workbin)
|
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestWorkbinNotifications create()
public static RequestWorkbinNotifications create(java.lang.Integer proxyClientId, KeyValueCollection extension, WorkbinInfo workbin, ReasonInfo reason, java.lang.Integer notifyPropertyChanges)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.workbin
- Workbinreason
- Reason.notifyPropertyChanges
- If present and set to non-zero value, Interaction Server will notify the subscriber about property changes for interactions located in the workbin by means of EventPropertiesChanged. Default value 0 (false).
public static RequestWorkbinNotifications create(WorkbinInfo workbin, ReasonInfo reason)
workbin
- Workbinreason
- Reason.
public abstract java.lang.Integer getTenantId()
public abstract void setTenantId(java.lang.Integer tenantId)
public abstract void setTenantId(int tenantId)
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract WorkbinInfo getWorkbin()
public abstract void setWorkbin(WorkbinInfo workbin)
public abstract ReasonInfo getReason()
public abstract void setReason(ReasonInfo reason)
public abstract java.lang.Integer getNotifyPropertyChanges()
public abstract void setNotifyPropertyChanges(java.lang.Integer notifyPropertyChanges)
public abstract void setNotifyPropertyChanges(int notifyPropertyChanges)
public abstract java.lang.Integer getIdsOnlyInTakenOutNotification()
public abstract void setIdsOnlyInTakenOutNotification(java.lang.Integer idsOnlyInTakenOutNotification)
idsOnlyInTakenOutNotification
- new value of the propertypublic abstract void setIdsOnlyInTakenOutNotification(int idsOnlyInTakenOutNotification)
idsOnlyInTakenOutNotification
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |