Message class

套件:

azure-iot-device

物件 Message 用於裝置到雲端) (遙測和命令， (裝置間) 裝置與IoT 中樞服務之間的非同步傳訊。 它與傳輸無關，這表示它的運作方式與 AMQP、MQTT 和 HTTP 相同。

建構函式

Message(BufferConvertible)

建立新的 Message 物件

屬性

ack	雲端到裝置命令) 時，要求的意見反應類型 (
contentEncoding	訊息本文的內容編碼。 可以是 'utf-8'、'utf-16' 或 'utf-32'。
contentType	用來路由傳送訊息本文的內容類型屬性。 應該是 'application/json'。
correlationId	用於訊息回應和意見反應
data
expiryTimeUtc	C2D 訊息中樞所解譯的 UTC 到期時間。 在其他情況下忽略。
interfaceId	此訊息是否為安全性訊息
lockToken	用來放棄、拒絕或接受訊息
messageId	用來相互關聯雙向通訊。 格式：區分大小寫的字串 (最多 128 個字元的 ASCII 7 位英數位元字元和下列特殊符號) ： - : . + % _ # * ? ! ( ) , = @ ; $ '.
properties	對應，包含用來儲存自訂訊息屬性的字串索引鍵和值。
to	訊息的目的地。
userId	用來指定建立訊息的實體

方法

getBytes()	取得傳遞至建構函式作為緩衝區的資料
getData()	取得 的內容 (本文) Message 。
isBufferConvertible(any)	如果指定的物件的類型為 BufferConvertible，則傳回 true。 BufferConvertible類型的物件可以傳遞至Message 建構函式。
setAsSecurityMessage()	將此訊息設定為安全性訊息

建構函式詳細資料

Message(BufferConvertible)

建立新的 Message 物件

new Message(data: BufferConvertible)

參數

data

BufferConvertible

Node Buffer 物件或任何可傳遞至 Buffer 建構函式的任何專案，以從中建構 Buffer 。

屬性詳細資料

ack

雲端到裝置命令) 時，要求的意見反應類型 (

ack: string

屬性值

string

contentEncoding

訊息本文的內容編碼。 可以是 'utf-8'、'utf-16' 或 'utf-32'。

contentEncoding: undefined | "utf-8" | "utf-16" | "utf-32"

屬性值

undefined | "utf-8" | "utf-16" | "utf-32"

contentType

用來路由傳送訊息本文的內容類型屬性。 應該是 'application/json'。

contentType: undefined | "application/json"

屬性值

undefined | "application/json"

correlationId

用於訊息回應和意見反應

correlationId: string

屬性值

string

data

data: any

屬性值

any

expiryTimeUtc

C2D 訊息中樞所解譯的 UTC 到期時間。 在其他情況下忽略。

expiryTimeUtc: any

屬性值

any

interfaceId

此訊息是否為安全性訊息

interfaceId: string

屬性值

string

lockToken

用來放棄、拒絕或接受訊息

lockToken: string

屬性值

string

messageId

用來相互關聯雙向通訊。 格式：區分大小寫的字串 (最多 128 個字元的 ASCII 7 位英數位元字元和下列特殊符號) ：
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

屬性值

string

properties

對應，包含用來儲存自訂訊息屬性的字串索引鍵和值。

properties: Properties

屬性值

Properties

to

訊息的目的地。

to: string

屬性值

string

userId

用來指定建立訊息的實體

userId: string

屬性值

string

方法詳細資料

getBytes()

取得傳遞至建構函式作為緩衝區的資料

function getBytes(): Buffer

傳回

Buffer

getData()

取得 的內容 (本文) Message 。

function getData(): BufferConvertible

傳回

BufferConvertible

的內容 Message 。

isBufferConvertible(any)

如果指定的物件的類型為 BufferConvertible，則傳回 true。 BufferConvertible類型的物件可以傳遞至Message 建構函式。

static function isBufferConvertible(obj: any): boolean

參數

obj

any

要檢查的物件實例

傳回

boolean

如果物件的類型為BufferConvertible，則為 True

setAsSecurityMessage()

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

function setAsSecurityMessage()