Class RetrieveEventData

Defines event data format for retrieving objects.

Hierarchy

CommunicationEventData
- RetrieveEventData

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

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

Overrides CommunicationEventData.constructor
- Defined in src/com/query-retrieve.ts:265
Create an instance of RetrieveEventData.

Parameters
- objects: CoatyObject[]
  
  An array of objects to be retrieved.
- Optional privateData: any
  
  Application-specific options (optional).
Returns RetrieveEventData

Accessors

objects

get objects(): CoatyObject[]

- Defined in src/com/query-retrieve.ts:288
An array of objects to be retrieved (array may be empty).

Returns CoatyObject[]

privateData

get privateData(): {}

- Defined in src/com/query-retrieve.ts:295
Application-specific options as an object hash (optional).

Returns {}
- [key: string]: any

Methods

toJsonObject

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

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

Static createFrom

createFrom(eventData: any): RetrieveEventData

- Defined in src/com/query-retrieve.ts:279
internal
For internal use in framework only.

Parameters
- eventData: any
Returns RetrieveEventData

Generated using TypeDoc