你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Message 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
数据结构表示用于与 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 |
如此 如果消息设置为安全消息 |
LockToken |
[必需]已接收消息的 LockToken |
MessageId |
[双向请求所必需的]用于关联双向通信。 格式:区分大小写的字符串 (最多 128 个字符长) ASCII 7 位字母数字字符
|
MessageSchema |
用于指定消息内容的架构。 |
Properties |
获取用户属性的字典,这些属性在用户发送数据时设置。 |
SequenceNumber |
[必需]收到的消息的 SequenceNumber |
To |
[必需]消息的目标 |
UserId |
[反馈消息中必需]用于指定设备中心生成的消息的来源。 可能的值:“{hub name}/” |
方法
CloneWithBody(Byte[]) |
克隆现有 Message 实例,并设置其上定义 |
Dispose() |
释放当前事件数据实例 |
GetBodyStream() |
返回当前事件数据实例的正文流 |
GetBytes() |
此方法将正文流作为字节数组返回 |
SetAsSecurityMessage() |
将消息设置为安全消息 |
显式接口实现
IReadOnlyIndicator.IsReadOnly |
数据结构表示用于与 IotHub 交互的消息。 |