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	用來將雙向通訊相互關聯。 格式：ASCII 7 位英數位元字元和下列特殊符號的區分大小寫字串（最多 128 個字元長）： - : . + % _ # * ? ! ( ) , = @ ; $ '。
properties	對應，包含用來儲存自定義訊息屬性的字串索引鍵和值。
to	訊息的目的地。
userId	用來指定建立訊息的實體

方法

getBytes()	取得當做 Buffer 傳遞至建構函式的數據
getData()	取得 Message的內容（本文）。
isBufferConvertible(any)	如果指定的對象的類型 BufferConvertible，則傳回 true。 BufferConvertible 類型的物件可以傳遞至訊息 建構函式。
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

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

messageId: string

屬性值

string

properties

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

properties: Properties

屬性值

Properties

to

訊息的目的地。

to: string

屬性值

string

userId

用來指定建立訊息的實體

userId: string

屬性值

string

方法詳細資料

getBytes()

取得當做 Buffer 傳遞至建構函式的數據

function getBytes(): Buffer

傳回

Buffer

getData()

取得 Message的內容（本文）。

function getData(): BufferConvertible

傳回

BufferConvertible

Message的內容。

isBufferConvertible(any)

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

static function isBufferConvertible(obj: any): boolean

參數

obj

any

要檢查的物件實例

傳回

boolean

True 是表示 如果對象的類型為 BufferConvertible

setAsSecurityMessage()

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

function setAsSecurityMessage()