Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BlockingQueryOptions

Options used to perform blocking query that used to wait for a potential change using long polling.

Hierarchy

  • BlockingQueryOptions

Index

Constructors

Methods

Constructors

constructor

Methods

getIndex

  • getIndex(): number

  • Set index indicating that the client wishes to wait for any changes subsequent to that index.

    Returns number

getWait

  • getWait(): string

  • Specifying a maximum duration for the blocking request. This is limited to 10 minutes. If not set, the wait time defaults to 5 minutes. This value can be specified in the form of "10s" or "5m" (i.e., 10 seconds or 5 minutes, respectively).

    Returns string

setIndex

  • Set index indicating that the client wishes to wait for any changes subsequent to that index.

    Parameters

    • index: number

    Returns BlockingQueryOptions

setWait

  • Specifying a maximum duration for the blocking request. This is limited to 10 minutes. If not set, the wait time defaults to 5 minutes. This value can be specified in the form of "10s" or "5m" (i.e., 10 seconds or 5 minutes, respectively).

    Parameters

    • wait: string

    Returns BlockingQueryOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc