DiscoverEvent | @coaty/core

Discover event.

Hierarchy

CommunicationEvent<DiscoverEventData>
- DiscoverEvent

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DiscoverEvent(_eventData: DiscoverEventData): DiscoverEvent

Inherited from CommunicationEvent<DiscoverEventData>.constructor
- Defined in src/com/communication-event.ts:39
internal
For internal use in framework only. Do not use in application code.

Create an event instance for the given event type.

Parameters
- _eventData: DiscoverEventData
Returns DiscoverEvent

Properties

eventRequest

eventRequest: CommunicationEvent<CommunicationEventData> = ...

internal: For internal use in framework only. Do not use in application code.

resolve

resolve: (event: ResolveEvent) => void

Type declaration

- (event: ResolveEvent): void
- Respond to an observed Discover event by returning the given event.
  
  Parameters
  - event: ResolveEvent
    
    a Resolve event
  Returns void

Accessors

data

get data(): T

- Defined in src/com/communication-event.ts:81
Gets the event data of this event.

Returns T

eventType

get eventType(): CommunicationEventType

- Defined in src/com/discover-resolve.ts:11
Returns CommunicationEventType

eventTypeFilter

get eventTypeFilter(): string

- Defined in src/com/communication-event.ts:18
internal
For internal use in framework only. Do not use in application code.

Returns string

responseEventType

get responseEventType(): CommunicationEventType

- Defined in src/com/discover-resolve.ts:15
Returns CommunicationEventType

sourceId

get sourceId(): string
set sourceId(sourceId: string): void

- Defined in src/com/communication-event.ts:65
Gets the object ID of the event source object.

Returns string
- Defined in src/com/communication-event.ts:74
Gets the object ID of the event source object.

internal
For internal use in framework only.

Sets the object ID of the event source object.

Parameters
- sourceId: string
Returns void

Methods

ensureValidResponseParameters

ensureValidResponseParameters(eventData: ResolveEventData): void

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

throws
if the given Resolve event data does not correspond to the event data of this Discover event.

Parameters
- eventData: ResolveEventData
  
  event data for Resolve response event
Returns void

Static isValidEventFilter

isValidEventFilter(name: string): boolean

Inherited from CommunicationEvent.isValidEventFilter
- Defined in src/com/communication-event.ts:58
Determines whether the given name is valid as an event filter for Coaty communication.

Event filters are used for Coaty communication event filtering, e.g. to filter a communication namespace, an object type, a channel identifier, or a remote operation.

An event filter is valid for communication if it is non-empty and does not contain the following characters: NULL (U+0000), # (U+0023), + (U+002B), / (U+002F).

Parameters
- name: string
  
  an event filter
Returns boolean
true if the given name can be used for event filtering; false otherwise

Static withCoreTypes

withCoreTypes(coreTypes: CoreType[]): DiscoverEvent

- Defined in src/com/discover-resolve.ts:79
Create a DiscoverEvent instance for discovering objects with the given core types.

Parameters
- coreTypes: CoreType[]
  
  the core types to discover
Returns DiscoverEvent

Static withExternalAndObjectId

withExternalAndObjectId(externalId: string, objectId: string): DiscoverEvent

- Defined in src/com/discover-resolve.ts:70
Create a DiscoverEvent instance for discovering objects with the given external Id and object Id.

Parameters
- externalId: string
  
  the external ID to discover
- objectId: string
  
  the object ID to discover
Returns DiscoverEvent

Static withExternalId

withExternalId(externalId: string): DiscoverEvent

- Defined in src/com/discover-resolve.ts:31
Create a DiscoverEvent instance for discovering objects with the given external Id.

Parameters
- externalId: string
  
  the external ID to discover
Returns DiscoverEvent

Static withExternalIdAndCoreTypes

withExternalIdAndCoreTypes(externalId: string, coreTypes: CoreType[]): DiscoverEvent

- Defined in src/com/discover-resolve.ts:41
Create a DiscoverEvent instance for discovering objects with the given external Id and core types.

Parameters
- externalId: string
  
  the external ID to discover
- coreTypes: CoreType[]
  
  an array of core types to discover
Returns DiscoverEvent

Static withExternalIdAndObjectTypes

withExternalIdAndObjectTypes(externalId: string, objectTypes: string[]): DiscoverEvent

- Defined in src/com/discover-resolve.ts:51
Create a DiscoverEvent instance for discovering objects with the given external Id and object types.

Parameters
- externalId: string
  
  the external ID to discover
- objectTypes: string[]
  
  an array of object types to discover
Returns DiscoverEvent

Static withObjectId

withObjectId(objectId: string): DiscoverEvent

- Defined in src/com/discover-resolve.ts:60
Create a DiscoverEvent instance for discovering objects with the given object Id.

Parameters
- objectId: string
  
  the object ID to discover
Returns DiscoverEvent

Static withObjectTypes

withObjectTypes(objectTypes: string[]): DiscoverEvent

- Defined in src/com/discover-resolve.ts:88
Create a DiscoverEvent instance for discovering objects with the given object types.

Parameters
- objectTypes: string[]
  
  the object types to discover
Returns DiscoverEvent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_eventData: DiscoverEventData

Returns DiscoverEvent

Properties

eventRequest

resolve

Type declaration

Parameters

event: ResolveEvent

Returns void

Accessors

data

Returns T

eventType

Returns CommunicationEventType

eventTypeFilter

Returns string

responseEventType

Returns CommunicationEventType

sourceId

Returns string

Parameters

sourceId: string

Returns void

Methods

ensureValidResponseParameters

Parameters

eventData: ResolveEventData

Returns void

Static isValidEventFilter

Parameters

name: string

Returns boolean

Static withCoreTypes

Parameters

coreTypes: CoreType[]

Returns DiscoverEvent

Static withExternalAndObjectId

Parameters

externalId: string

objectId: string

Returns DiscoverEvent

Static withExternalId

Parameters

externalId: string

Returns DiscoverEvent

Static withExternalIdAndCoreTypes

Parameters

externalId: string

coreTypes: CoreType[]

Returns DiscoverEvent

Static withExternalIdAndObjectTypes

Parameters

externalId: string

objectTypes: string[]

Returns DiscoverEvent

Static withObjectId

Parameters

objectId: string

Returns DiscoverEvent

Static withObjectTypes

Parameters

objectTypes: string[]

Returns DiscoverEvent