@salesforce/core
Options
All
  • Public
  • Public/Protected
  • All
Menu

Default Streaming Options. Uses Faye as the cometd impl.

Hierarchy

  • DefaultOptions

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructor for DefaultStreamingOptions

    see

    StatusResult

    Parameters

    • org: Org

      The streaming target org

    • channel: string

      The streaming channel or topic. If the topic is a system topic then api 36.0 is used. System topics are deprecated.

    • streamProcessor: StreamProcessor

      The function called that can process streaming messages.

    • Default value envDep: Env = env

    Returns DefaultOptions

Properties

apiVersion

apiVersion: string

channel

channel: string

handshakeTimeout

handshakeTimeout: Duration

org

org: Org

streamProcessor

streamProcessor: StreamProcessor

streamingImpl

streamingImpl: StreamingClientIfc

subscribeTimeout

subscribeTimeout: Duration

Static DEFAULT_HANDSHAKE_TIMEOUT

DEFAULT_HANDSHAKE_TIMEOUT: Duration = Duration.seconds(30)

Static DEFAULT_SUBSCRIBE_TIMEOUT

DEFAULT_SUBSCRIBE_TIMEOUT: Duration = Duration.minutes(3)

Static SFDX_ENABLE_FAYE_COOKIES_ALLOW_ALL_PATHS

SFDX_ENABLE_FAYE_COOKIES_ALLOW_ALL_PATHS: "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING" = "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING"

Static SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING

SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING: "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING" = "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING"

Methods

setHandshakeTimeout

  • setHandshakeTimeout(newTime: Duration): void

  • Setter for the handshake timeout.

    throws

    An error if the newTime is less than the default time.

    Parameters

    • newTime: Duration

      The new handshake timeout

    Returns void

setSubscribeTimeout

  • setSubscribeTimeout(newTime: Duration): void

  • Setter for the subscribe timeout.

    throws

    An error if the newTime is less than the default time.

    Parameters

    • newTime: Duration

      The new subscribe timeout.

    Returns void