Jsprivate

Name

CommandParameters

Hierarchy

  • CommandParameters

Constructors

Methods

  • 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 CommandParameters

    The updated CommandParameters object (to permit a fluent programming style).

  • Gets the payload

    Returns any

    the payload

  • Sets the command associated with a CommandSubscription to be cancelled in the event that the connection goes down before it is sent.

    Returns CommandParameters

    The updated CommandParameters object (to permit a fluent programming style).

  • Sets the payload object, this should be of the type specified in the payload type.

    Parameters

    • obj: any

      the payload ojbject

    Returns CommandParameters

  • Sets the command associated with a CommandSubscription to be persistent. This deals with the situation where the connection to the Liberator server has been lost, and on subsequent reconnection StreamLink must create a brand new user session and log in to Liberator again. When this happens, the "persistent" command is automatically re-sent to the Liberator.

    Returns CommandParameters

    The updated CommandParameters object (to permit a fluent programming style).

Generated using TypeDoc