Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommandParameters

jsprivate
name

CommandParameters

Hierarchy

  • CommandParameters

Index

Methods

Methods

getPayload

  • getPayload(): any

  • Gets the payload

    Returns any

    the payload

getPayloadType

  • Gets the payload type

    Returns PayloadType

    the payload type

setCancellable

  • 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).

setPayload

  • setPayload(obj: any): void

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

    Parameters

    • obj: any

      the payload ojbject

    Returns void

setPayloadType

  • Sets the type of the payload

    Parameters

    Returns void

setPersistent

  • 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