ServiceBusMessageBatch interface

Paquet:

@azure/service-bus

Lot de messages que vous pouvez créer à l’aide de la méthode <xref:createBatch>.

Propriétés

count	Nombre de messages ajoutés au lot.
maxSizeInBytes	Taille maximale du lot, en octets. La fonction tryAddMessage sur le lot retourne false si le message ajouté entraîne le dépassement de cette limite par la taille du lot. Utilisez la méthode createMessageBatch() sur l'Sender pour définir le maxSizeInBytes.
sizeInBytes	Taille du lot en octets après que les événements ajoutés à celui-ci aient été encodés dans un seul message AMQP.

Méthodes

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Ajoute un message au lot s’il est autorisé par la limite de taille du lot. REMARQUE: n’oubliez pas de vérifier la valeur de retour de cette méthode avant de l’appeler à nouveau pour l’événement suivant.

Détails de la propriété

count

Nombre de messages ajoutés au lot.

count: number

Valeur de propriété

number

maxSizeInBytes

Taille maximale du lot, en octets. La fonction tryAddMessage sur le lot retourne false si le message ajouté entraîne le dépassement de cette limite par la taille du lot. Utilisez la méthode createMessageBatch() sur l'Sender pour définir le maxSizeInBytes.

maxSizeInBytes: number

Valeur de propriété

number

sizeInBytes

Taille du lot en octets après que les événements ajoutés à celui-ci aient été encodés dans un seul message AMQP.

sizeInBytes: number

Valeur de propriété

number

Détails de la méthode

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Ajoute un message au lot s’il est autorisé par la limite de taille du lot. REMARQUE: n’oubliez pas de vérifier la valeur de retour de cette méthode avant de l’appeler à nouveau pour l’événement suivant.

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

Paramètres

message

ServiceBusMessage | AmqpAnnotatedMessage

Message à ajouter au lot.

options

TryAddOptions

Retours

boolean

Valeur booléenne indiquant si le message a été ajouté au lot ou non.