Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordSubscriptionParameters

jsprivate
name

RecordSubscriptionParameters

Hierarchy

Index

Methods

Methods

setFields

  • Sets the record fields that will be requested when a subscription is made using these parameters.

    If no fields are defined, then your SubscriptionListener receives all fields that are available for the subject.

    Parameters

    • fields: string[]

      The record fields to be requested.

    Returns RecordSubscriptionParameters

    The updated RecordSubscriptionParameters object to permit a fluent style.

setFilter

  • Sets the filter that restricts the the information returned by the subscription. The filtering is performed by the Liberator, rather than the client, so that bandwidth and client side processing are reduced.

    For more details on the format of the filter string, please see the StreamLink Overview document.

    Parameters

    • filter: string

      The filter string.

    • isImage: boolean

      true if the filter string should only be applied to the initial record data (image) supplied in response to the subscription request, false if the filter string should be applied to the initial record and every subsequent update.

    Returns RecordSubscriptionParameters

    The updated RecordSubscriptionParameters object to permit a fluent style.

Generated using TypeDoc