ServiceBusMessageBatch interface

Paket:

@azure/service-bus

En batch med meddelanden som du kan skapa med hjälp av <xref:createBatch> metoden .

Egenskaper

count	Antal meddelanden som lagts till i batchen.
maxSizeInBytes	Den maximala storleken för batchen, i byte. Funktionen tryAddMessage i batchen returneras false om meddelandet som läggs till gör att batchens storlek överskrider den här gränsen. createMessageBatch() Använd metoden på för Sender att ange maxSizeInBytes.
sizeInBytes	Batchens storlek i byte efter att händelserna som lagts till har kodats i ett enda AMQP-meddelande.

Metoder

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Lägger till ett meddelande i batchen om det tillåts av batchens storleksgräns. Obs! Kom alltid ihåg att kontrollera returvärdet för den här metoden innan du anropar den igen för nästa händelse.

Egenskapsinformation

count

Antal meddelanden som lagts till i batchen.

count: number

Egenskapsvärde

number

maxSizeInBytes

Den maximala storleken för batchen, i byte. Funktionen tryAddMessage i batchen returneras false om meddelandet som läggs till gör att batchens storlek överskrider den här gränsen. createMessageBatch() Använd metoden på för Sender att ange maxSizeInBytes.

maxSizeInBytes: number

Egenskapsvärde

number

sizeInBytes

Batchens storlek i byte efter att händelserna som lagts till har kodats i ett enda AMQP-meddelande.

sizeInBytes: number

Egenskapsvärde

number

Metodinformation

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Lägger till ett meddelande i batchen om det tillåts av batchens storleksgräns. Obs! Kom alltid ihåg att kontrollera returvärdet för den här metoden innan du anropar den igen för nästa händelse.

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

Parametrar

message

ServiceBusMessage | AmqpAnnotatedMessage

Meddelandet som ska läggas till i batchen.

options

TryAddOptions

Returer

boolean

Ett booleskt värde som anger om meddelandet har lagts till i batchen eller inte.