Class CompleteEventData

Defines event data format for Complete events.

Hierarchy

CommunicationEventData
- CompleteEventData

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

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

Overrides CommunicationEventData.constructor
- Defined in src/com/update-complete.ts:152
Create an instance of CompleteEventData.

Parameters
- object: CoatyObject
  
  The updated object.
- Optional privateData: any
  
  Application-specific options (optional).
Returns CompleteEventData

Accessors

object

get object(): CoatyObject

- Defined in src/com/update-complete.ts:175
The updated object.

Returns CoatyObject

privateData

get privateData(): {}

- Defined in src/com/update-complete.ts:182
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/update-complete.ts:186
Returns { object: CoatyObject; privateData: {} }
- object: CoatyObject
- privateData: {}
  - [key: string]: any

Static createFrom

createFrom(eventData: any): CompleteEventData

- Defined in src/com/update-complete.ts:166
internal
For internal use in framework only.

Parameters
- eventData: any
Returns CompleteEventData

Generated using TypeDoc