Class ResolveEventData

Defines event data format for resolving objects.

Hierarchy

CommunicationEventData
- ResolveEventData

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new ResolveEventData(object?: CoatyObject, relatedObjects?: CoatyObject[], privateData?: any): ResolveEventData

Overrides CommunicationEventData.constructor
- Defined in src/com/discover-resolve.ts:401
Create an instance of ResolveEventData. At least one of the parameters object or relatedObjects is required. The privateData parameter is optional.

Parameters
- Optional object: CoatyObject
  
  The object to be resolved.
- Optional relatedObjects: CoatyObject[]
  
  Related objects, i.e. child objects to be resolved.
- Optional privateData: any
  
  Application-specific options (optional).
Returns ResolveEventData

Accessors

object

get object(): CoatyObject

- Defined in src/com/discover-resolve.ts:369
The object to be resolved (may be undefined if relatedObjects property is defined).

Returns CoatyObject

privateData

get privateData(): {}

- Defined in src/com/discover-resolve.ts:384
Application-specific options as an object hash (optional).

Returns {}
- [key: string]: any

relatedObjects

get relatedObjects(): CoatyObject[]

- Defined in src/com/discover-resolve.ts:377
Related objects, i.e. child objects to be resolved (may be undefined if object property is defined).

Returns CoatyObject[]

Methods

toJsonObject

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

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

Static createFrom

createFrom(eventData: any): ResolveEventData

- Defined in src/com/discover-resolve.ts:417
internal
For internal use in framework only.

Parameters
- eventData: any
Returns ResolveEventData

Generated using TypeDoc