Package version
Cancels a message that was scheduled to appear on a ServiceBus Queue/Subscription.
The sequence number of the message to be cancelled.
Promise
Cancels multiple messages that were scheduled to appear on a ServiceBus Queue/Subscription.
An Array of sequence numbers of the messages to be cancelled.
Promise
Closes the underlying AMQP sender link.
Once closed, the sender cannot be used for any further operations.
Use the createSender function on the QueueClient or TopicClient to instantiate a new Sender
Opens the AMQP link to Azure Service Bus from the sender.
It is not necessary to call this method in order to use the sender. It is recommended to call this before your first send() or sendBatch() call if you want to front load the work of setting up the AMQP link to the service.
Schedules given message to appear on Service Bus Queue/Subscription at a later time.
Please note that you need to explicitly encode the message body if you intend to receive the message using a tool or library other than this library. For example:
const dt = new DefaultDataTransformer();encode method on the transformer to encode the message body before calling the scheduleMessage() method message.body = dt.encode(message.body);The UTC time at which the message should be enqueued.
The message that needs to be scheduled.
PromiseLong type as-is in your application without converting to number. Since JavaScript
only supports 53 bit numbers, converting the Long to number will cause loss in precision.
Schedules given messages to appear on Service Bus Queue/Subscription at a later time.
Please note that you need to explicitly encode the message body if you intend to receive the message using a tool or library other than this library. For example:
const dt = new DefaultDataTransformer();encode method on the transformer to encode the message body before calling the scheduleMessage() method message.body = dt.encode(message.body);The UTC time at which the messages should be enqueued.
Array of Messages that need to be scheduled.
Promise<Long[]> - The sequence numbers of messages that were scheduled.
You will need the sequence number if you intend to cancel the scheduling of the messages.
Save the Long type as-is in your application without converting to number. Since JavaScript
only supports 53 bit numbers, converting the Long to number will cause loss in precision.
Sends the given message after creating an AMQP Sender link if it doesnt already exists.
To send a message to a session and/or partition enabled Queue/Topic, set the sessionId
and/or partitionKey properties respectively on the message.
Message to send.
Promise
Sends the given messages in a single batch i.e. in a single AMQP message after creating an AMQP Sender link if it doesnt already exists.
session and/or partition enabled Queue/Topic, set the sessionId
and/or partitionKey properties respectively on the messages.sessionId (if using sessions) and the same
partitionKey (if using partitions).An array of SendableMessageInfo objects to be sent in a Batch message.
Promise
Generated using TypeDoc
The Sender class can be used to send messages, schedule messages to be sent at a later time and cancel such scheduled messages. Use the
createSenderfunction on the QueueClient or TopicClient to instantiate a Sender. The Sender class is an abstraction over the underlying AMQP sender link.