Package version
Path of the entity for which the receiver has been created.
ReceiveMode provided to the client.
The session ID.
Closes the receiver.
Once closed, the receiver cannot be used for any further operations.
Use the createReceiver() method on the ServiceBusClient to create a new Receiver.
Returns an iterator that can be used to receive messages from Service Bus.
If the iterator is not able to fetch a new message in over a minute, undefined will be returned.
A set of options to control the receive operation.
maxWaitTimeInMs: The time to wait to receive the message in each iteration.abortSignal: The signal to use to abort the ongoing operation.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
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.The maximum number of messages to peek.
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.
Returns a promise that resolves to an array of deferred messages identified by given sequenceNumbers.
The sequence number or an array of sequence numbers for the messages that need to be received.
Options bag to pass an abort signal or tracing options.
Returns a promise that resolves to an array of messages received from Service Bus.
The maximum number of messages to receive.
A set of options to control the receive operation.
maxWaitTimeInMs: The maximum time to wait for the first message before returning an empty array if no messages are available.abortSignal: The signal to use to abort the ongoing operation.Promise<ReceivedMessageT[]> A promise that resolves with an array of messages.
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.
An object that can be closed, sending any remaining messages to handlers and
stopping new messages from arriving.
Causes the subscriber to stop receiving new messages.
Generated using TypeDoc
A receiver that handles sessions, including renewing the session lock.