Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceBusSender

Package version

A Sender can be used to send messages, schedule messages to be sent at a later time and cancel such scheduled messages. Use the createSender function on the ServiceBusClient to instantiate a Sender. The Sender class is an abstraction over the underlying AMQP sender link.

Hierarchy

  • ServiceBusSender

Index

Properties

entityPath

entityPath: string

Path of the entity for which the sender has been created.

isClosed

isClosed: boolean

Returns true if either the sender or the client that created it has been closed.

readonly

Methods

cancelScheduledMessages

  • cancelScheduledMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<void>
  • Cancels multiple messages that were scheduled to appear on a ServiceBus Queue/Subscription.

    throws

    Error if the underlying connection, client or sender is closed.

    throws

    ServiceBusError if the service returns an error while canceling scheduled messages.

    Parameters

    • sequenceNumbers: Long | Long[]

      Sequence number or an array of sequence numbers of the messages to be cancelled.

    • Optional options: OperationOptionsBase

      Options bag to pass an abort signal or tracing options.

    Returns Promise<void>

close

  • close(): Promise<void>

createMessageBatch

  • Creates an instance of ServiceBusMessageBatch to which one can add messages until the maximum supported size is reached. The batch can be passed to the {@link send} method to send the messages to Azure Service Bus.

    throws

    ServiceBusError if an error is encountered while sending a message.

    throws

    Error if the underlying connection or sender has been closed.

    Parameters

    • Optional options: CreateMessageBatchOptions

      Configures the behavior of the batch.

      • maxSizeInBytes: The upper limit for the size of batch. The tryAdd function will return false after this limit is reached.

    Returns Promise<ServiceBusMessageBatch>

scheduleMessages

  • Schedules given messages to appear on Service Bus Queue/Subscription at a later time.

    throws

    Error if the underlying connection, client or sender is closed.

    throws

    ServiceBusError if the service returns an error while scheduling messages.

    Parameters

    • messages: ServiceBusMessage | ServiceBusMessage[] | AmqpAnnotatedMessage | AmqpAnnotatedMessage[]

      Message or an array of messages that need to be scheduled.

    • scheduledEnqueueTimeUtc: Date

      The UTC time at which the messages should be enqueued.

    • Optional options: OperationOptionsBase

      Options bag to pass an abort signal or tracing options.

    Returns 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.

sendMessages

  • Sends the given messages after creating an AMQP Sender link if it doesn't already exist.

    • To send messages to a session and/or partition enabled Queue/Topic, set the sessionId and/or partitionKey properties respectively on the messages.
    • All messages passed to the same sendMessages() call should have the same sessionId (if using sessions) and the same partitionKey (if using partitions).
    throws

    ServiceBusError with the code MessageSizeExceeded if the provided messages do not fit in a single ServiceBusMessageBatch.

    throws

    Error if the underlying connection, client or sender is closed.

    throws

    ServiceBusError if the service returns an error while sending messages to the service.

    Parameters

    Returns Promise<void>

Generated using TypeDoc