次の方法で共有

Message class

  • リファレンス
パッケージ:
azure-iot-device

オブジェクトはMessage、デバイスとIoT Hub サービスの間のテレメトリ (device-to-cloud) とコマンド (cloud-to-device) の非同期メッセージングに使用されます。 トランスポートに依存しません。つまり、AMQP、MQTT、HTTP で同じように動作します。

コンストラクター

Message(BufferConvertible)

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

プロパティ

ack

要求されたフィードバックの種類 (cloud-to-device コマンドの場合)
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()

バッファーとしてコンストラクターに渡されるデータを取得します
getData()

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

指定したオブジェクトが BufferConvertible 型の場合は true を返します。 BufferConvertible 型のオブジェクトは、Message コンストラクターに渡すことができます。
setAsSecurityMessage()

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

コンストラクターの詳細

Message(BufferConvertible)

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

new Message(data: BufferConvertible)

パラメーター

data
BufferConvertible

Node Buffer オブジェクト、または Buffer コンストラクターに渡して Buffer を構築できるもの。

プロパティの詳細

ack

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

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()

バッファーとしてコンストラクターに渡されるデータを取得します

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()