Class SubscribeRequest

constructor

• new SubscribeRequest(msg: Subscribe): SubscribeRequest

  Parameters

  • msg: Subscribe

  Returns SubscribeRequest

Readonlycontroller

endGroup

expectedStreams

forward

ReadonlyfullTrackName

isCanceled

largestLocation

priority

ReadonlyrequestId

startLocation

Readonlystream

streamsAccepted

subscribeParameters

ReadonlytrackAlias

catch

• catch<TResult = never>(
      onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>),
  ): Promise<SubscribeError | SubscribeOk | TResult>

  Type Parameters

  • TResult = never

  Parameters

  • Optionalonrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

  Returns Promise<SubscribeError | SubscribeOk | TResult>

finally

• finally(onfinally?: null | (() => void)): Promise<SubscribeError | SubscribeOk>

  Parameters

  • Optionalonfinally: null | (() => void)

  Returns Promise<SubscribeError | SubscribeOk>

reject

• reject(reason?: any): void

  Parameters

  • Optionalreason: any

  Returns void

resolve

• resolve(
      value:
          | SubscribeError
          | SubscribeOk
          | PromiseLike<SubscribeError | SubscribeOk>,
  ): void

  Parameters

  • value: SubscribeError | SubscribeOk | PromiseLike<SubscribeError | SubscribeOk>

  Returns void

then

• then<TResult1 = SubscribeError | SubscribeOk, TResult2 = never>(
      onfulfilled?:
          | null
          | (
              (
                  value: SubscribeError | SubscribeOk,
              ) => TResult1 | PromiseLike<TResult1>
          ),
      onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>),
  ): PromiseLike<TResult1 | TResult2>

  Attaches callbacks for the resolution and/or rejection of the Promise.

  Type Parameters

  • TResult1 = SubscribeError | SubscribeOk
  • TResult2 = never

  Parameters

  • Optionalonfulfilled:
        | null
        | (
            (
                value: SubscribeError | SubscribeOk,
            ) => TResult1 | PromiseLike<TResult1>
        )

    The callback to execute when the Promise is resolved.
  • Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

    The callback to execute when the Promise is rejected.

  Returns PromiseLike<TResult1 | TResult2>

  A Promise for the completion of which ever callback is executed.

unsubscribe

• unsubscribe(): void

  Returns void

update

• update(msg: SubscribeUpdate): void

  Parameters

  • msg: SubscribeUpdate

  Returns void