Class Event.AcknowledgementEvent
Represents an event which is used as an acknowledgement for an event
datagram
Defined in: <D:\Programs\Neeve\Projects\NeeveBuild16\stjsapi/src/main/webapp/js\event\AcknowledgementEvent.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Event.AcknowledgementEvent(eventId)
Creates a new acknowledgement event
|
Method Attributes | Method Name and Description |
---|---|
Object |
Gets the acknowledgement data of the event
|
String |
Gets the event acknowledge action.
|
String |
Gets the expiration period of the acknowledged event.
|
String |
Gets the event id of the acknowledged event
|
String |
Gets the event source of the acknowledged event
|
number |
Gets the timestamp of the acknowledged event.
|
Object |
getData()
Gets the acknowledgement data of the event
|
String |
Gets the id of the acknowledgement recipient
|
void |
setAction(action)
Sets the acknowledge action.
|
void |
setCorrelationEventExpiration(expiration)
Sets the specified time as an expiration period of the event
acknowledged by this event.
|
void |
Sets the specified id as an event id of the event
acknowledged by this event
|
void |
setCorrelationEventSource(source)
Sets the specified source as an event source of the event
acknowledged by this event
|
void |
setCorrelationEventTimeStamp(timestamp)
Sets the specified timestamp as a timestamp of the event
acknowledged by this event.
|
void |
setData(data)
Sets acknowledgement data of the event
|
void |
setRecipientID(id)
Sets the id of the acknowledgement recipient
|
Class Detail
Event.AcknowledgementEvent(eventId)
Creates a new acknowledgement event
- Parameters:
- {String} eventId
- The id of the acknowledgement event to be created
Method Detail
{Object}
getAcknowledgementData()
Gets the acknowledgement data of the event
- Returns:
- The acknowledgement data
{String}
getAction()
Gets the event acknowledge action. See
HTTPFabricConnection#acknowledgeEvent for action values.
- Returns:
- The acknowledge action
{String}
getCorrelationEventExpiration()
Gets the expiration period of the acknowledged event. The value is
returned in milliseconds (since January 1, 1970, 00:00:00 GMT).
- Returns:
- The acknowledged event expiration period
{String}
getCorrelationEventId()
Gets the event id of the acknowledged event
- Returns:
- The acknowledged event id
{String}
getCorrelationEventSource()
Gets the event source of the acknowledged event
- Returns:
- The acknowledged event source
{number}
getCorrelationEventTimeStamp()
Gets the timestamp of the acknowledged event. The value is returned in
milliseconds (since January 1, 1970, 00:00:00 GMT).
- Returns:
- The acknowledged event timestamp
{Object}
getData()
Gets the acknowledgement data of the event
- Returns:
- The acknowledgement data
{String}
getRecipientID()
Gets the id of the acknowledgement recipient
- Returns:
- The acknowledgement recipient id
setAction(action)
Sets the acknowledge action. See
HTTPFabricConnection#acknowledgeEvent for action values.
- Parameters:
- {String} action
- The acknowledge action to be set
setCorrelationEventExpiration(expiration)
Sets the specified time as an expiration period of the event
acknowledged by this event. The value should be specified in milliseconds
(since January 1, 1970, 00:00:00 GMT).
- Parameters:
- {number} expiration
- The expiration period of the acknowledged event to be set
setCorrelationEventId(id)
Sets the specified id as an event id of the event
acknowledged by this event
- Parameters:
- {String} id
- The id of the acknowledged event to be set
setCorrelationEventSource(source)
Sets the specified source as an event source of the event
acknowledged by this event
- Parameters:
- {String} source
- The source of the acknowledged event to be set
setCorrelationEventTimeStamp(timestamp)
Sets the specified timestamp as a timestamp of the event
acknowledged by this event. The value should be specified in milliseconds
(since January 1, 1970, 00:00:00 GMT).
- Parameters:
- {number} timestamp
- The timestamp of the acknowledged event to be set
setData(data)
Sets acknowledgement data of the event
- Parameters:
- {String} data
- The acknowledgement data to be set
setRecipientID(id)
Sets the id of the acknowledgement recipient
- Parameters:
- {String} id
- The acknowledgement recipient id