ServiceBusMessageBatch interface
您可以使用 <xref:createBatch> 方法建立的訊息批次。
屬性
count | 新增至批次的訊息數目。 |
max |
批次的大小上限,以位元組為單位。 如果新增的訊息導致批次的大小超過此限制,批次上的 |
size |
新增至批次的事件已編碼成單一 AMQP 訊息之後,批次的大小以位元組為單位。 |
方法
try |
如果批次的大小限制允許,請將訊息新增至批次。 NOTE:請記得先檢查這個方法的傳回值,然後再針對下一個事件再次呼叫它。 |
屬性詳細資料
count
新增至批次的訊息數目。
count: number
屬性值
number
maxSizeInBytes
批次的大小上限,以位元組為單位。 如果新增的訊息導致批次的大小超過此限制,批次上的 tryAddMessage
函式將會傳回 false
。 使用 Sender
上的 createMessageBatch()
方法來設定 maxSizeInBytes。
maxSizeInBytes: number
屬性值
number
sizeInBytes
新增至批次的事件已編碼成單一 AMQP 訊息之後,批次的大小以位元組為單位。
sizeInBytes: number
屬性值
number
方法詳細資料
tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)
如果批次的大小限制允許,請將訊息新增至批次。 NOTE:請記得先檢查這個方法的傳回值,然後再針對下一個事件再次呼叫它。
function tryAddMessage(message: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean
參數
- message
要新增至批次的訊息。
- options
- TryAddOptions
傳回
boolean
布爾值,指出訊息是否已新增至批次。