Session

Methods

• registerSnapshotParameters

  • registerSnapshotParameters(parameters: SnapshotParameters): Handle

    Register parameters to use for snapshots.

    Parameters

    • parameters: SnapshotParametersThe parameters.

    Returns Handle

    A handle. This handle should be deleted once it is finished with, but must kept and not deleted whilst in use.

• registerSubscriptionParameters

  • registerSubscriptionParameters(parameters: SubscriptionParameters): Handle

    Register parameters to use for subscriptions.

    Parameters

    • parameters: SubscriptionParametersThe parameters.

    Returns Handle

    A handle. This handle should be deleted once it is finished with, but must kept and not deleted whilst in use.

• snapshot

  • snapshot(topic: TopicRequest, handler?: ISnapshotHandler, snapshotParameters?: Handle): SnapshotHandle

    Snapshot a topic.

    Parameters

    • topic: TopicRequestThe topic to snapshot.
    • handler?: ISnapshotHandlerThe optional snapshot handler.
    • snapshotParameters?: HandleThe optional handle of the snapshot parameters to use.

    Returns SnapshotHandle

    A SnapshotHandle for iterating the snapshot response.

• subscribe

  • subscribe(topic: TopicRequest, handler?: ISubscriptionHandler, subscriptionParameters?: Handle): SubscriptionHandle

    Subscribe to a topic.

    Parameters

    • topic: TopicRequestThe topic to subscribe to.
    • handler?: ISubscriptionHandlerThe optional subscription handler.
    • subscriptionParameters?: HandleThe optional handle of the subscription parameters to use.

    Returns SubscriptionHandle

    A SubscriptionHandle for iterating the subscription.

• query

  • query(query: TagQuery, handler?: IQueryHandler): QueryHandle

    Query for topic ids matching a tag expression.

    Parameters

    • query: TagQueryThe tag expression to query.
    • handler?: IQueryHandlerThe optional query handler.

    Returns QueryHandle

    A QueryHandle for iterating the results of the query.

• querySnapshot

  • querySnapshot(query: TagQuery, handler?: ISnapshotHandler, snapshotParameters?: Handle): SnapshotHandle

    Snapshot topics using a query.

    Parameters

    • query: TagQueryThe tag expression to snapshot.
    • handler?: ISnapshotHandlerThe optional snapshot handler.
    • snapshotParameters?: HandleThe optional handle of the snapshot parameters to use.

    Returns SnapshotHandle

    A SnapshotHandle for iterating the snapshot response.

• querySubscribe

  • querySubscribe(query: TagQuery, handler?: ISubscriptionHandler, subscriptionParameters?: Handle): SubscriptionHandle

    Subscribe to topics using a query.

    Parameters

    • query: TagQueryThe tag expression to subscribe to.
    • handler?: ISubscriptionHandlerThe optional subscription handler.
    • subscriptionParameters?: HandleThe optional handle of the subscription parameters to use.

    Returns SubscriptionHandle

    A SubscriptionHandle for iterating the subscription.

• disconnect

  • disconnect(): void

    Disconnect from a gateway.

    Returns void

• getMetadata

  • getMetadata(): Metadata

    Metadata for the gateway connection.

    Returns Metadata

Properties

• readonly disconnected: Promise<void>

  Use this property to monitor the life of a connection. It will be resolved upon a successful user-initiated disconnection or rejected if an unexpected break in the connection occurs.

  NB the API will not attempt to automatically reconnect.