Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryEvent

Query event.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • internal

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

    Create an event instance for the given event type.

    Parameters

    Returns QueryEvent

Properties

eventRequest

eventRequest: CommunicationEvent<CommunicationEventData> = ...
internal

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

retrieve

retrieve: (event: RetrieveEvent) => void

Type declaration

    • Respond to an observed Query event by returning the given event.

      Parameters

      Returns void

Accessors

data

  • get data(): T

eventType

eventTypeFilter

  • get eventTypeFilter(): string

responseEventType

sourceId

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

Methods

ensureValidResponseParameters

  • internal

    For internal use in framework only.

    throws

    if the given Retrieve event data does not correspond to the event data of this Query event.

    Parameters

    Returns void

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 withCoreTypes

  • Create a QueryEvent instance for querying the given core types, filter, and join conditions. The object filter and join conditions are optional.

    Parameters

    Returns QueryEvent

Static withObjectTypes

  • Create a QueryEvent instance for querying the given object types, filter, and join conditions. The object filter and join conditions are optional.

    Parameters

    • objectTypes: string[]

      restrict results by object types (logical OR).

    • Optional objectFilter: ObjectFilter

      restrict results by object filter (optional).

    • Optional objectJoinConditions: ObjectJoinCondition | ObjectJoinCondition[]

      join related objects into results (optional).

    Returns QueryEvent

Generated using TypeDoc