Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RetrieveEvent

Retrieve event with associated request event.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

eventRequest

eventRequest: QueryEvent
internal

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

Associated request event.

Accessors

data

  • get data(): T

eventType

eventTypeFilter

  • get eventTypeFilter(): string

responseEventType

sourceId

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

Methods

Static isValidEventFilter

  • isValidEventFilter(name: string): boolean

  • 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 withObjects

Generated using TypeDoc