你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

BrokeredMessage 类

定义

命名空间:

Microsoft.ServiceBus.Messaging

程序集:

Microsoft.ServiceBus.dll

包:

WindowsAzure.ServiceBus v6.2.2

表示服务总线客户端之间的通信单位。

public sealed class BrokeredMessage : IDisposable, System.Xml.Serialization.IXmlSerializable

type BrokeredMessage = class
    interface IXmlSerializable
    interface IDisposable

Public NotInheritable Class BrokeredMessage
Implements IDisposable, IXmlSerializable

继承

Object

BrokeredMessage

实现

IDisposable IXmlSerializable

构造函数

BrokeredMessage()	初始化 BrokeredMessage 类的新实例。
BrokeredMessage(Object)	使用 DataContractSerializer 和二进制 XmlDictionaryWriter 从给定对象初始化 类的新实例 BrokeredMessage 。
BrokeredMessage(Object, XmlObjectSerializer)	使用提供的 XmlObjectSerializer 从给定对象创建 BrokeredMessage 的构造函数
BrokeredMessage(Stream)	初始化 BrokeredMessage 类的新实例。
BrokeredMessage(Stream, Boolean)	使用提供的流作为其主体初始化 类的新实例 BrokeredMessage 。

属性

ContentType	获取或设置内容的类型。
CorrelationId	获取或设置关联的标识符。
DeadLetterSource	表示服务总线客户端之间的通信单位。
DeliveryCount	获取传递数。
EnqueuedSequenceNumber	获取或设置消息的排队序列号。
EnqueuedTimeUtc	获取发送时间的日期和时间（以 UTC 为单位）。
ExpiresAtUtc	获取消息设置为过期的 UTC 日期和时间。
ForcePersistence	获取或设置一个值，该值指示消息是否立即保存到数据库，而不是在内存中保留短时间。 如果将消息发送到非快速队列或主题，则忽略此属性。
IsBodyConsumed	指定消息是否已使用。
Label	获取或设置特定于应用程序的标签。
LockedUntilUtc	获取在队列/订阅中锁定消息之前的 UTC 日期和时间。
LockToken	获取服务总线分配给此消息的锁令牌。
MessageId	获取或设置消息的标识符。 这是用户定义的值，服务总线可以使用该值标识重复的消息（如果已启用）。
PartitionKey	获取或设置一个分区键，用于将事务消息发送到非会话感知的队列或主题。
Properties	获取特定于应用程序的消息属性。
ReplyTo	获取或设置要答复的队列的地址。
ReplyToSessionId	获取或设置要答复的会话标识符。
ScheduledEnqueueTimeUtc	获取或设置将消息排入队列的 UTC 日期和时间。 此属性返回 UTC 时间;设置 属性时，提供的 DateTime 值也必须采用 UTC 格式。
SequenceNumber	获取服务总线分配给消息的唯一编号。
SessionId	获取或设置会话的标识符。
Size	获取消息的大小（以字节为单位）。
State	获取或设置消息的状态。
TimeToLive	获取或设置消息的生存时间值。 这是消息到期之前所要经过的持续时间，从向 Service Bus 发送该消息时算起。 超过 TimeToLive 值的消息将会到期，不再保留在消息存储中。 订阅者将无法接收过期的消息。TimeToLive 是消息可以接收的最长生存期，但其值不能超过在目标队列或订阅上指定 DefaultMessageTimeToLive 值的实体。 如果指定了较低的 TimeToLive 值，它将应用于单个消息。 但是，在消息上指定的较大值将被实体的 DefaultMessageTimeToLive 值替代。
To	获取或设置发送到地址。
ViaPartitionKey	获取或设置一个分区键值，当事务用于通过传输队列发送消息时。

方法

Abandon()	放弃对速览锁定消息的锁定。
Abandon(IDictionary<String,Object>)	放弃对速览锁定消息的锁定。
AbandonAsync()	异步放弃对速览锁定消息的锁定。
AbandonAsync(IDictionary<String,Object>)	异步放弃对速览锁定消息的锁定。
Clone()	克隆消息，以便可以将消息的克隆作为新消息发送。
Complete()	完成消息的接收操作，并指示应将消息标记为已处理和删除。
CompleteAsync()	异步完成消息的接收操作，并指示应将消息标记为已处理和删除。
DeadLetter()	将消息移动到死信队列。
DeadLetter(IDictionary<String,Object>)	将消息移动到死信队列。
DeadLetter(String, String)	将消息移动到死信队列。
DeadLetterAsync()	以异步方式将消息移动到死信队列。
DeadLetterAsync(IDictionary<String,Object>)	以异步方式将消息移动到死信队列。
DeadLetterAsync(String, String)	以异步方式将消息移动到死信队列。
Defer()	指示接收方希望延迟此消息的处理。
Defer(IDictionary<String,Object>)	指示接收方希望延迟此消息的处理。
DeferAsync()	异步指示接收方希望延迟此消息的处理。
DeferAsync(IDictionary<String,Object>)	异步指示接收方希望延迟此消息的处理。
Dispose()	执行与释放或重置非托管资源关联的应用程序定义的任务。
GetBody<T>()	将 DataContractSerializer 中转消息正文反序列化为具有二进制 XmlDictionaryReader类型的 对象。
GetBody<T>(XmlObjectSerializer)	使用具有 Binary XmlObjectSerializer 的 DataContractSerializer 将 BrokeredMessage 正文反序列化为指定类型的对象。
RenewLock()	续订对消息的锁定。
RenewLockAsync()	异步续订消息的锁。
ToString()	返回表示当前消息的字符串。

显式接口实现

IXmlSerializable.GetSchema()	此方法是保留方法，请不要使用。 实现 IXmlSerializable 接口时，应从此方法返回 null (Visual Basic 中) Nothing，相反，如果需要指定自定义架构，则向 类应用 XmlSchemaProviderAttribute。
IXmlSerializable.ReadXml(XmlReader)	从其 XML 表示形式生成对象。 此方法保留供内部使用，不应直接或间接使用 (例如，使用序列化程序或格式化程序) 。
IXmlSerializable.WriteXml(XmlWriter)	将对象转换为其 XML 表示形式。 此方法保留供内部使用，不应直接或间接使用 (例如使用序列化程序或格式化程序) 。