Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AdvertiseEvent

Advertise event.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • internal

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

    Create an Advertise event instance.

    The objectType of the object specified in the given event data must be a non-empty string that does not contain the following characters: NULL (U+0000), # (U+0023), + (U+002B), / (U+002F).

    throws

    if object type of given object is not in a valid format

    Parameters

    Returns AdvertiseEvent

Properties

eventRequest

eventRequest: CommunicationEvent<CommunicationEventData> = ...
internal

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

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 withObject

  • Create an AdvertiseEvent instance for advertising the given object.

    throws

    if object type of given object is not in a valid format

    Parameters

    • object: CoatyObject

      the object to be advertised

    • Optional privateData: any

      application-specific options (optional)

    Returns AdvertiseEvent

Generated using TypeDoc