Class AdvertiseEventData

Defines event data format for advertising objects.

Hierarchy

CommunicationEventData
- AdvertiseEventData

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new AdvertiseEventData(object: CoatyObject, privateData?: any): AdvertiseEventData

Overrides CommunicationEventData.constructor
- Defined in src/com/advertise.ts:62
Create an instance of AdvertiseEventData.

Parameters
- object: CoatyObject
  
  The object to be advertised.
- Optional privateData: any
  
  Application-specific options (optional).
Returns AdvertiseEventData

Accessors

object

get object(): CoatyObject

- Defined in src/com/advertise.ts:85
The object to be advertised.

Returns CoatyObject

privateData

get privateData(): {}

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

Returns {}
- [key: string]: any

Methods

toJsonObject

toJsonObject(): { object: CoatyObject; privateData: {} }

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

Static createFrom

createFrom(eventData: any): AdvertiseEventData

- Defined in src/com/advertise.ts:76
internal
For internal use in framework only.

Parameters
- eventData: any
Returns AdvertiseEventData

Generated using TypeDoc