Package version
Path of the entity for which the receiver has been created.
ReceiveMode provided to the client.
The session ID.
Closes the receiver.
Returns an iterator that can be used to receive messages from Service Bus.
Options for getMessageIterator.
Gets the state of the Session. For more on session states, see Session State
Options bag to pass an abort signal or tracing options.
The state of that session
Indicates whether the receiver is currently receiving messages or not.
When this returns true, new registerMessageHandler() or receiveMessages() calls cannot be made.
Peek the next batch of active messages (including deferred but not deadlettered messages) on the queue or subscription without modifying them.
peekMessages() fetches the first active message. Each subsequent call fetches the
subsequent message.Completed/Abandoned/Deferred/Deadlettered.Options that allow to specify the maximum number of messages to peek, the sequenceNumber to start peeking from or an abortSignal to abort the operation.
Receives, at most, maxMessages worth of messages.
The maximum number of messages to accept.
Options for receiveBatch.
Returns a promise that resolves to a deferred message identified by the given sequenceNumber.
The sequence number of the message that needs to be received.
Options bag to pass an abort signal or tracing options.
Message identified by sequence number.undefined if no such message is found.Returns a promise that resolves to an array of deferred messages identified by given sequenceNumbers.
An array of sequence numbers for the messages that need to be received.
Options bag to pass an abort signal or tracing options.
Renews the lock on the session.
Sets the state on the Session. For more on session states, see Session State
Options bag to pass an abort signal or tracing options.
Streams messages to message handlers.
A handler that gets called for messages and errors.
Options for subscribe.
Generated using TypeDoc
A receiver that handles sessions, including renewing the session lock.