Package version
The client entity context.
Closes the Sender|Receiver link and it's underlying session and also removes it from the internal map.
Ensures that the token is renewed within the predefined renewal margin.
Negotiates the cbs claim for the ClientEntity.
Promise
Adds a rule on the subscription as defined by the given rule name, filter and action
Name of the rule
A Boolean, SQL expression or a Correlation filter
Action to perform if the message satisfies the filtering expression
Cancels an array of messages that were scheduled.
An Array of sequence numbers of the message to be cancelled.
Promise
Closes the AMQP management session to the ServiceBus namespace for this client, returning a promise that will be resolved when disconnection is completed.
Promise
Get all the rules on the Subscription.
Promise<RuleDescription[]> A list of rules.
Gets the state of the specified session.
The session for which the state needs to be retrieved.
Promise
Lists the sessions on the ServiceBus Queue/Topic.
The number of sessions to skip
Maximum numer of sessions.
Promise<string[]> A list of session ids.
Fetches the next batch of active messages. The first call to peek() fetches the first
active message for this client. Each subsequent call fetches the subsequent message in the
entity.
Unlike a received message, peeked message will not have lock token associated with it,
and hence it cannot be Completed/Abandoned/Deferred/Deadlettered/Renewed. This method will
also fetch even Deferred messages (but not Deadlettered message).
Promise<ReceivedSBMessage[]>
Peeks the desired number of messages from the specified sequence number.
The sequence number from where to read the message.
The sessionId from which messages need to be peeked.
Promise<ReceivedMessageInfo[]>
Fetches the next batch of active messages in the current MessageSession. The first call to
peek() fetches the first active message for this client. Each subsequent call fetches the
subsequent message in the entity.
Unlike a received message, peeked message will not have lock token associated with it,
and hence it cannot be Completed/Abandoned/Deferred/Deadlettered/Renewed. This method will
also fetch even Deferred messages (but not Deadlettered message).
The sessionId from which messages need to be peeked.
Promise<ReceivedMessageInfo[]>
Receives a list of deferred messages identified by sequenceNumbers.
A list containing the sequence numbers to receive.
The mode in which the receiver was created.
Promise<ServiceBusMessage[]>
Removes the rule on the Subscription identified by the given rule name.
Renews the lock on the message. The lock will be renewed based on the setting specified on the queue.
When a message is received in PeekLock mode, the message is locked on the server for this
receiver instance for a duration as specified during the Queue/Subscription creation
(LockDuration). If processing of the message requires longer than this duration, the
lock needs to be renewed. For each renewal, it resets the time the message is locked by the
LockDuration set on the Entity.
Lock token of the message
Promise
Renews the lock for the specified session.
Id of the session for which the lock needs to be renewed
Options that can be set while sending the request.
Promise
Schedules an array of messages to appear on Service Bus at a later time.
The UTC time at which the messages should be enqueued.
An array of messages that needs to be scheduled.
Promise
Sets the state of the specified session.
The session for which the state needs to be set
The state that needs to be set.
Promise
Updates the disposition status of deferred messages.
Optional parameters that can be provided while updating the disposition status.
Promise
Generated using TypeDoc