Class Event.MapEvent
Represents an event with a map payload
Defined in: </home/ubuntu/streamscape/NeeveBuild/stjsapi/src/main/webapp/js/event/MapEvent.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Event.MapEvent(eventId)
Creates a new map event
|
Method Attributes | Method Name and Description |
---|---|
void |
Clears the map
|
Object |
Returns the map payload of the event to be used in an acknowlegement.
|
String |
Returns the keys of the map
|
Object |
getValue(key)
Gets the value of the map entry specified by its key
|
Object |
itemExists(key)
Returns whether or not the specified key is contained in the map
|
void |
setValue(key, value)
Sets the specified value with the specified key in the map
|
Class Detail
Event.MapEvent(eventId)
Creates a new map event
- Parameters:
- {String} eventId
- The id of the map event to be created
Method Detail
clearData()
Clears the map
{Object}
getAcknowledgementData()
Returns the map payload of the event to be used in an acknowlegement.
- Returns:
- The map payload for an acknowlegement event
{String[]}
getMapNames()
Returns the keys of the map
- Returns:
- An array of the map keys
{Object}
getValue(key)
Gets the value of the map entry specified by its key
- Parameters:
- {String} key
- The key of the map entry
- Returns:
- The value of the map entry
{Object}
itemExists(key)
Returns whether or not the specified key is contained in the map
- Parameters:
- {String} key
- The key to be checked
- Returns:
- True if the map contains the key, false otherwise
setValue(key, value)
Sets the specified value with the specified key in the map
- Parameters:
- {String} key
- The key of the value to be set
- {Object} value
- The value to be set