Class idx.bus.BusMessage

EXPERIMENTAL API: Message for use with idx.bus
Defined in: <idx\bus\BusMessage.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	idx.bus.BusMessage()

Field Summary

Field Attributes	Field Name and Description
	args The object containing any additional arguments for handling the message.
	broadcast Set to true to broadcast the message upstream even if it has already been handled by at least one subscriber within the local scope, otherwise set to false if the message should only be propagated upstream if it has not been handled within local scope.
	messageType The message type is a string that uniquely defines an action to be taken.
	scope The scope for the message.
	source The source of the requested action.

Method Summary

Method Attributes	Method Name and Description
	appendResult(source, result) Appends the result
	constructor(args) Constructs with the specified arguments.
	getResultCount() Access for results length
	isHandled() Accessor for result count

Constructor Detail

idx.bus.BusMessage()

Field Detail

{Object} args

The object containing any additional arguments for handling the message.

Default Value:: null

{Boolean} broadcast

Set to true to broadcast the message upstream even if it has already been handled by at least one subscriber within the local scope, otherwise set to false if the message should only be propagated upstream if it has not been handled within local scope.

Default Value:: false

{String} messageType

The message type is a string that uniquely defines an action to be taken. The set of handled messages depends on the subscribers that are subscribed to the bus. Specific subscribers can be designed to handle certain messages while leaving other kinds to other subscribers.

Default Value:: ""

{String} scope

The scope for the message. If the message is targeted at a specific scope it is easier for subscribers to filter it and prevent action names from overlapping in namespaces. Some subscribers may in fact listen to all action scopes.

Default Value:: ""

{String} source

The source of the requested action.

Default Value:: null

Method Detail

appendResult(source, result)

Appends the result

Parameters:
{Object} source
{Object} result

constructor(args)

Constructs with the specified arguments.

Parameters:
{Object} args

getResultCount()

Access for results length

Returns:

{Boolean} isHandled()

Accessor for result count

Returns:: {Boolean}