Class ChannelEventData

Defines event data format for channelizing objects.

Hierarchy

CommunicationEventData
- ChannelEventData

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new ChannelEventData(object?: CoatyObject, objects?: CoatyObject[], privateData?: any): ChannelEventData

Overrides CommunicationEventData.constructor
- Defined in src/com/channel.ts:91
Create an instance of ChannelEventData. Exactly one of the parameters object or objects is required. The privateData parameter is optional.

Parameters
- Optional object: CoatyObject
  
  The object to be channelized.
- Optional objects: CoatyObject[]
  
  The objects to be channelized.
- Optional privateData: any
  
  Application-specific options (optional).
Returns ChannelEventData

Accessors

object

get object(): CoatyObject

- Defined in src/com/channel.ts:117
The object to be channelized.

Returns CoatyObject

objects

get objects(): CoatyObject[]

- Defined in src/com/channel.ts:124
The objects to be channelized.

Returns CoatyObject[]

privateData

get privateData(): {}

- Defined in src/com/channel.ts:131
Application-specific options as an object hash (optional).

Returns {}
- [key: string]: any

Methods

toJsonObject

toJsonObject(): { object: CoatyObject; objects: CoatyObject[]; privateData: {} }

Overrides CommunicationEventData.toJsonObject
- Defined in src/com/channel.ts:135
Returns { object: CoatyObject; objects: CoatyObject[]; privateData: {} }
- object: CoatyObject
- objects: CoatyObject[]
- privateData: {}
  - [key: string]: any

Static createFrom

createFrom(eventData: any): ChannelEventData

- Defined in src/com/channel.ts:107
internal
For internal use in framework only.

Parameters
- eventData: any
Returns ChannelEventData

Generated using TypeDoc