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

布林值，指出訊息是否已新增至批次。