Class ChannelEvent

Channel event.

Hierarchy

CommunicationEvent<ChannelEventData>
- ChannelEvent

Index

Constructors

constructor

Properties

eventRequest

Accessors

Methods

Constructors

constructor

new ChannelEvent(channelId: string, eventData: ChannelEventData): ChannelEvent

Overrides CommunicationEvent<ChannelEventData>.constructor
- Defined in src/com/channel.ts:38
internal
For internal use in framework only. Do not use in application code.

Create a Channel event instance.

The channel identifier must be a non-empty string that does not contain the following characters: NULL (U+0000), # (U+0023), + (U+002B), / (U+002F).

throws
if channel identifier is not in a valid format

Parameters
- channelId: string
  
  the channel identifier of this Channel event
- eventData: ChannelEventData
  
  data associated with this Channel event
Returns ChannelEvent

Properties

eventRequest

eventRequest: CommunicationEvent<CommunicationEventData> = ...

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

Accessors

channelId

get channelId(): string

- Defined in src/com/channel.ts:19
Returns string

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/channel.ts:11
Returns CommunicationEventType

eventTypeFilter

get eventTypeFilter(): string

- Defined in src/com/channel.ts:15
Returns string

responseEventType

get responseEventType(): CommunicationEventType

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

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

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 withObject

withObject(channelId: string, object: CoatyObject, privateData?: any): ChannelEvent

- Defined in src/com/channel.ts:57
Create a ChannelEvent instance for delivering the given object.

throws
if channel identifier is not in a valid format

Parameters
- channelId: string
- object: CoatyObject
  
  the object to be channelized
- Optional privateData: any
  
  application-specific options (optional)
Returns ChannelEvent

Static withObjects

withObjects(channelId: string, objects: CoatyObject[], privateData?: any): ChannelEvent

- Defined in src/com/channel.ts:68
Create a ChannelEvent instance for delivering the given objects.

throws
if channel identifier is not in a valid format

Parameters
- channelId: string
- objects: CoatyObject[]
  
  the objects to be channelized
- Optional privateData: any
  
  application-specific options (optional)
Returns ChannelEvent

Generated using TypeDoc