IBaseRequestParameters

Common parameters for all streaming request types.

Extended by

Properties

  • subscription?: ISubscriptionParameters

    Optional subscription to updates for the returned record(s).
  • aliasMode?: AliasMode

    How to handle alias records. Default if not specified is equivalent to AliasMode.normal.
  • permissionLevel?: PermissionLevel

    By default, the API will return the best permissioned record(s) (where realtime is considered better than delayed). If the user is permissioned for both realtime and delayed, it is possible to force retrieval of the delayed record(s) by specifying PermissionLevel.delayed here.

Also in this Section

Functions

Interfaces