Message クラス

定義

データ構造は、IotHub との対話に使用されるメッセージを表します。

public sealed class Message : IDisposable, Microsoft.Azure.Devices.Client.IReadOnlyIndicator
type Message = class
    interface IReadOnlyIndicator
    interface IDisposable
Public NotInheritable Class Message
Implements IDisposable, IReadOnlyIndicator
継承
Message
実装

コンストラクター

Message()

本文データのない既定のコンストラクター

Message(Byte[])

入力バイト配列を本文として使用するコンストラクター。

Message(Stream)

引数ストリームを本文ストリームとして使用するコンストラクター。

プロパティ

BodyStream

現在のイベント データ インスタンスの本文ストリーム

ComponentName

テレメトリ メッセージの送信元の DTDL コンポーネント名。 これは、プラグ アンド プレイ認定デバイスにのみ関連します。

ConnectionDeviceId

このメッセージが送信されたデバイス ID (存在する場合) を指定します。

ConnectionModuleId

このメッセージが送信されたモジュール ID (存在する場合) を指定します。

ContentEncoding

メッセージのコンテンツ エンコードの種類を指定するために使用します。

ContentType

メッセージのコンテンツ タイプを指定するために使用します。

CorrelationId

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

CreationTimeUtc

メッセージの発信元によって設定されるカスタム日付プロパティ。

DeliveryCount

メッセージが以前に配信された回数

EnqueuedTimeUtc

デバイスからクラウドへのメッセージがサーバーによって受信された日時。

ExpiryTimeUtc

[省略可能]このメッセージが期限切れと見なされる時刻

InputName

メッセージが送信された入力名 (存在する場合) を指定します。

IsSecurityMessage

True を指定すると、メッセージがセキュリティ メッセージとして設定されます

LockToken

[必須]受信したメッセージの LockToken

MessageId

[双方向要求に必要]双方向通信を関連付けるために使用されます。 形式: ASCII 7 ビット英数字文字の大文字と小文字を区別する文字列 (最大 128 文字)

  • {'-', ':', '/', '', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. 英数字以外の文字は、URN RFC から取得されます。
MessageSchema

メッセージ コンテンツのスキーマを指定するために使用します。

Properties

ユーザーがデータを送信するときに設定されるユーザー プロパティのディクショナリを取得します。

SequenceNumber

[必須]受信したメッセージの SequenceNumber

To

[必須]メッセージの送信先

UserId

[フィードバック メッセージで必須]デバイス ハブによって生成されるメッセージの配信元を指定するために使用します。 使用可能な値: "{hub name}/"

メソッド

CloneWithBody(Byte[])

既存 Message のインスタンスを複製し、 によって定義された byteArray コンテンツ本文を設定します。

Dispose()

現在のイベント データ インスタンスを破棄する

GetBodyStream()

現在のイベント データ インスタンスの本文ストリームを返します

GetBytes()

このメソッドは、本文ストリームをバイト配列として返します

SetAsSecurityMessage()

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

明示的なインターフェイスの実装

IReadOnlyIndicator.IsReadOnly

データ構造は、IotHub との対話に使用されるメッセージを表します。

適用対象