ServiceBusMessageBatch interface

Csomag:

@azure/service-bus

Üzenetköteg, amelyet a <xref:createBatch> metódussal hozhat létre.

Tulajdonságok

count	A köteghez hozzáadott üzenetek száma.
maxSizeInBytes	A köteg maximális mérete bájtban. A köteg tryAddMessage függvénye false ad vissza, ha a hozzáadott üzenet miatt a köteg mérete meghaladja ezt a korlátot. A createMessageBatch()Sender metódusával állítsa be a maxSizeInBytes értéket.
sizeInBytes	A köteg mérete bájtban, miután a hozzá hozzáadott eseményeket egyetlen AMQP-üzenetbe kódolták.

Metódusok

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Ha a köteg méretkorlátja megengedi, üzenetet ad hozzá a köteghez. MEGJEGYZÉS: Mindig ellenőrizze ennek a metódusnak a visszatérési értékét, mielőtt újra meghívja a következő eseményhez.

Tulajdonság adatai

count

A köteghez hozzáadott üzenetek száma.

count: number

Tulajdonság értéke

number

maxSizeInBytes

A köteg maximális mérete bájtban. A köteg tryAddMessage függvénye false ad vissza, ha a hozzáadott üzenet miatt a köteg mérete meghaladja ezt a korlátot. A createMessageBatch()Sender metódusával állítsa be a maxSizeInBytes értéket.

maxSizeInBytes: number

Tulajdonság értéke

number

sizeInBytes

A köteg mérete bájtban, miután a hozzá hozzáadott eseményeket egyetlen AMQP-üzenetbe kódolták.

sizeInBytes: number

Tulajdonság értéke

number

Metódus adatai

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Ha a köteg méretkorlátja megengedi, üzenetet ad hozzá a köteghez. MEGJEGYZÉS: Mindig ellenőrizze ennek a metódusnak a visszatérési értékét, mielőtt újra meghívja a következő eseményhez.

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

Paraméterek

message

ServiceBusMessage | AmqpAnnotatedMessage

A köteghez hozzáadni kívánt üzenet.

options

TryAddOptions

Válaszok

boolean

Logikai érték, amely jelzi, hogy az üzenet hozzá lett-e adva a köteghez.