Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReceiveOptions

Package version

internal

Hierarchy

Index

Properties

Optional autoComplete

autoComplete: undefined | false | true
property

Indicates whether the complete() method on the message should automatically be called by the sdk after the user provided onMessage handler has been executed. Calling complete() on a message removes it from the Queue/Subscription.

  • Default: true.

Optional maxConcurrentCalls

maxConcurrentCalls: undefined | number
property

The maximum number of concurrent calls that the sdk can make to the user's message handler. Once this limit has been reached, further messages will not be received until at least one of the calls to the user's message handler has completed.

  • Default: 1.

Optional maxMessageAutoRenewLockDurationInMs

maxMessageAutoRenewLockDurationInMs: undefined | number
property

The maximum duration in milliseconds until which the lock on the message will be renewed by the sdk automatically. This auto renewal stops once the message is settled or once the user provided onMessage handler completes ite execution.

  • Default: 300 * 1000 milliseconds (5 minutes).
  • To disable autolock renewal, set this to 0.

Optional receiveMode

receiveMode: ReceiveMode
property

{number} [receiveMode] The mode in which messages should be received. Default: ReceiveMode.peekLock

Optional retryOptions

retryOptions: RetryOptions

Retry policy options that determine the mode, number of retries, retry interval etc.

Generated using TypeDoc