Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JsonSubscriptionParameters

jsprivate
name

JsonSubscriptionParameters

Hierarchy

Index

Methods

addHeader

  • For REST operations this adds a HTTP header to be used by the resulting REST request. The order in which the headers are added will be the order in which they are applied to the REST operation.

    Parameters

    • name: string

      the name of the HTTP header

    • value: string

      the value of the header

    Returns JsonSubscriptionParameters

    The updated JsonSubscriptionParameters 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 https://goessner.net/articles/JsonPath/.

    Parameters

    • filter: string

      The filter string.

    Returns JsonSubscriptionParameters

    The updated JsonSubscriptionParameters object to permit a fluent style.

Generated using TypeDoc