Class DefaultOptions

constructor

• new DefaultOptions(
      org: Org,
      channel: string,
      streamProcessor: StreamProcessor,
      envDep?: Env,
  ): DefaultOptions

  Constructor for DefaultStreamingOptions

  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.

  • envDep: Env = env

  Returns DefaultOptions

  See

  StatusResult

apiVersion

channel

handshakeTimeout

org

streamingImpl

streamProcessor

subscribeTimeout

Static ReadonlyDEFAULT_HANDSHAKE_TIMEOUT

Static ReadonlyDEFAULT_SUBSCRIBE_TIMEOUT

Static ReadonlySFDX_ENABLE_FAYE_COOKIES_ALLOW_ALL_PATHS

Static ReadonlySFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING

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 DefaultOptions.DEFAULT_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. DefaultOptions.DEFAULT_SUBSCRIBE_TIMEOUT

  Returns void