Message class

新しい Message オブジェクトを作成します

new Message(data: BufferConvertible)

パラメーター

要求されたフィードバックの種類 (cloud-to-device コマンドの場合)

ack: string

プロパティ値

メッセージ本文のコンテンツ エンコード。 には、'utf-8'、'utf-16' または 'utf-32' を指定できます。

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

プロパティ値

メッセージ本文でルーティングするために使用されるコンテンツ タイプ プロパティ。 'application/json' にする必要があります。

contentType: "application/json" | undefined

プロパティ値

メッセージの応答とフィードバックで使用されます

correlationId: string

プロパティ値

data: any

プロパティ値

C2D メッセージのハブによって解釈される UTC の有効期限。 それ以外の場合は無視されます。

expiryTimeUtc: any

プロパティ値

このメッセージはセキュリティ メッセージか

interfaceId: string

プロパティ値

メッセージを破棄、拒否、または承諾するために使用されます

lockToken: string

プロパティ値

双方向通信を関連付けるために使用されます。 形式: ASCII 7 ビット英数字文字と次の特殊な記号の大文字と小文字を区別する文字列 (最大 128 文字)。
- : . + % _ # * ? ! ( ) , = @ ; $ '。

messageId: string

プロパティ値

カスタム メッセージ プロパティを格納するための文字列キーと値を含むマップ。

properties: Properties

プロパティ値

メッセージの宛先。

to: string

プロパティ値

メッセージを作成するエンティティを指定するために使用されます

userId: string

プロパティ値

Buffer としてコンストラクターに渡されるデータを取得します。

function getBytes(): Buffer

返品

Messageのコンテンツ (本文) を取得します。

function getData(): BufferConvertible

返品

Messageの内容。

与えられたオブジェクトが Message.BufferConvertible型であればtrueを返します。 Message.BufferConvertible型のオブジェクトは、Messageコンストラクタに渡すことができます。

static function isBufferConvertible(obj: any): boolean

パラメーター

返品

オブジェクトがMessage.BufferConvertible型の場合は真です

このメッセージをセキュリティ メッセージとして設定します

function setAsSecurityMessage()