ServiceBusMessageBatch interface

Pakiet:

@azure/service-bus

Partia komunikatów, które można utworzyć przy użyciu <xref:createBatch> metody .

Właściwości

count	Liczba komunikatów dodanych do partii.
maxSizeInBytes	Maksymalny rozmiar partii w bajtach. Funkcja tryAddMessage w partii zostanie zwrócona false , jeśli dodawany komunikat spowoduje przekroczenie tego limitu rozmiaru partii. createMessageBatch() Użyj metody w obiekcie , Sender aby ustawić wartość maxSizeInBytes.
sizeInBytes	Rozmiar partii w bajtach po dodaniu do niego zdarzeń został zakodowany w jednym komunikacie protokołu AMQP.

Metody

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Dodaje komunikat do partii, jeśli jest dozwolony przez limit rozmiaru partii. UWAGA: Zawsze pamiętaj, aby sprawdzić wartość zwracaną tej metody przed wywołaniem go ponownie dla następnego zdarzenia.

Szczegóły właściwości

count

Liczba komunikatów dodanych do partii.

count: number

Wartość właściwości

number

maxSizeInBytes

Maksymalny rozmiar partii w bajtach. Funkcja tryAddMessage w partii zostanie zwrócona false , jeśli dodawany komunikat spowoduje przekroczenie tego limitu rozmiaru partii. createMessageBatch() Użyj metody w obiekcie , Sender aby ustawić wartość maxSizeInBytes.

maxSizeInBytes: number

Wartość właściwości

number

sizeInBytes

Rozmiar partii w bajtach po dodaniu do niego zdarzeń został zakodowany w jednym komunikacie protokołu AMQP.

sizeInBytes: number

Wartość właściwości

number

Szczegóły metody

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Dodaje komunikat do partii, jeśli jest dozwolony przez limit rozmiaru partii. UWAGA: Zawsze pamiętaj, aby sprawdzić wartość zwracaną tej metody przed wywołaniem go ponownie dla następnego zdarzenia.

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

Parametry

message

ServiceBusMessage | AmqpAnnotatedMessage

Komunikat do dodania do partii.

options

TryAddOptions

Zwraca

boolean

Wartość logiczna wskazująca, czy komunikat został dodany do partii, czy nie.