QueueMessage 類別

佇列訊息物件。

繼承

azure.functions._abc.QueueMessage

QueueMessage

建構函式

QueueMessage(*, id: str | None = None, body: str | bytes | None = None, pop_receipt: str | None = None)

參數

名稱	Description
id 必要	str 指定訊息識別碼的選擇性字串。
body 必要	指定訊息本文的字串或位元組實例。
pop_receipt 必要	str 包含快顯收據權杖的選擇性字串。

僅限關鍵字的參數

名稱	Description
id 必要
body 必要
pop_receipt 必要

方法

get_body	以位元組傳回訊息內容。
get_json	將訊息內容解碼並傳回為 JSON 物件。

get_body

以位元組傳回訊息內容。

get_body() -> bytes

get_json

將訊息內容解碼並傳回為 JSON 物件。

get_json() -> Any

傳回

類型	Description
	解碼的 JSON 資料。

例外狀況

類型	Description
ValueError	當訊息本文不包含有效的 JSON 資料時。

屬性

dequeue_count

此訊息已從佇列清除的次數。

expiration_time

具有訊息到期時間的 datetime 物件。

id

訊息識別碼。

insertion_time

具有訊息佇列插入時間的 datetime 物件。

pop_receipt

訊息快顯回條權杖做為字串。

time_next_visible

日期時間物件，下一個會顯示訊息的時間。