Message 類別

  • 參考

代表來自 IoTHub 的訊息

訊息的初始化運算式

繼承
builtins.object
Message

建構函式

Message(data, message_id=None, content_encoding=None, content_type=None, output_name=None)

參數

名稱 Description
data
必要

構成承載的資料
message_id
str

使用者可設定的訊息識別碼，用於「要求-回覆」模式。 格式：區分大小寫的字串 (最多 128 個字元長) ASCII 7 位英數位元 + {'-'， '：'、'.'、'+'、'%'、'_'、'#'、'*'、'？'、'！'、' ('、') '、'、'='、'@'、';'、'$'、''''}

預設值: None
content_encoding
str

訊息資料的內容編碼。 其他值可以是 utf-16' 或 'utf-32'

預設值: None
content_type
str

用來路由傳送訊息本文的內容類型屬性。

預設值: None
output_name
str

要傳送的輸出名稱。

預設值: None

變數

名稱 Description
data

構成承載的資料
custom_properties

自訂訊息屬性的字典。 這些屬性的索引鍵和值一律為字串。
id
<xref:message>

使用者可設定的訊息識別碼，用於「要求-回覆」模式。 格式：區分大小寫的字串 (最多 128 個字元長) ASCII 7 位英數位元 + {'-'， '：'、'.'、'+'、'%'、'_'、'#'、'*'、'？'、'！'、' ('、') '、'、'='、'@'、';'、'$'、''''}
expiry_time_utc

UTC 格式的郵件到期日期和時間
correlation_id

回應訊息中通常包含要求message_id的屬性，在要求-回復模式中
user_id

用來指定訊息來源的識別碼
content_encoding

訊息資料的內容編碼。 可以是 'utf-8'、'utf-16' 或 'utf-32'
content_type

用來透過訊息本文路由傳送訊息的內容類型屬性。 可以是 'application/json'
output_name

要傳送訊息的輸出名稱。
input_name

收到訊息的輸入名稱。

方法

get_size
set_as_security_message

將訊息設定為安全性訊息。

這是一個暫時的 API。 尚未保證的功能。

get_size 

get_size()

set_as_security_message

將訊息設定為安全性訊息。

這是一個暫時的 API。 尚未保證的功能。

set_as_security_message()

屬性

iothub_interface_id