ServiceBusMessageBatch interface

Пакет:

@azure/service-bus

Пакет сообщений, которые можно создать с помощью <xref:createBatch> метода .

Свойства

count	Количество сообщений, добавленных в пакет.
maxSizeInBytes	Максимальный размер пакета в байтах. Функция tryAddMessage в пакете вернет, false если добавляемое сообщение приведет к превышению этого предела размером пакета. createMessageBatch() Используйте метод в , Sender чтобы задать maxSizeInBytes.
sizeInBytes	Размер пакета в байтах после того, как события, добавленные в него, были закодированы в одно сообщение AMQP.

Методы

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Добавляет сообщение в пакет, если это разрешено ограничением размера пакета. ПРИМЕЧАНИЕ. Всегда не забудьте проверить возвращаемое значение этого метода, прежде чем вызывать его еще раз для следующего события.

Сведения о свойстве

count

Количество сообщений, добавленных в пакет.

count: number

Значение свойства

number

maxSizeInBytes

Максимальный размер пакета в байтах. Функция tryAddMessage в пакете вернет, false если добавляемое сообщение приведет к превышению этого предела размером пакета. createMessageBatch() Используйте метод в , Sender чтобы задать maxSizeInBytes.

maxSizeInBytes: number

Значение свойства

number

sizeInBytes

Размер пакета в байтах после того, как события, добавленные в него, были закодированы в одно сообщение AMQP.

sizeInBytes: number

Значение свойства

number

Сведения о методе

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Добавляет сообщение в пакет, если это разрешено ограничением размера пакета. ПРИМЕЧАНИЕ. Всегда не забудьте проверить возвращаемое значение этого метода, прежде чем вызывать его еще раз для следующего события.

function tryAddMessage(message: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

Параметры

message

ServiceBusMessage | AmqpAnnotatedMessage

Сообщение для добавления в пакет.

options

TryAddOptions

Возвращаемое значение

boolean

Логическое значение, указывающее, было ли сообщение добавлено в пакет.