BrokeredMessage
BrokeredMessage
BrokeredMessage
BrokeredMessage
Class
Definition
Represents the unit of communication between Service Bus clients.
public ref class BrokeredMessage sealed : IDisposable, System::Xml::Serialization::IXmlSerializable
public sealed class BrokeredMessage : IDisposable, System.Xml.Serialization.IXmlSerializable
type BrokeredMessage = class
interface IXmlSerializable
interface IDisposable
Public NotInheritable Class BrokeredMessage
Implements IDisposable, IXmlSerializable
- Inheritance
- Implements
Constructors
Properties
ContentType ContentType ContentType ContentType |
Gets or sets the type of the content. |
CorrelationId CorrelationId CorrelationId CorrelationId |
Gets or sets the identifier of the correlation. |
DeadLetterSource DeadLetterSource DeadLetterSource DeadLetterSource | |
DeliveryCount DeliveryCount DeliveryCount DeliveryCount |
Gets the number of deliveries. |
EnqueuedSequenceNumber EnqueuedSequenceNumber EnqueuedSequenceNumber EnqueuedSequenceNumber |
Gets or sets the enqueued sequence number of the message. |
EnqueuedTimeUtc EnqueuedTimeUtc EnqueuedTimeUtc EnqueuedTimeUtc |
Gets or sets the date and time of the sent time in UTC. |
ExpiresAtUtc ExpiresAtUtc ExpiresAtUtc ExpiresAtUtc |
Gets the date and time in UTC at which the message is set to expire. |
ForcePersistence ForcePersistence ForcePersistence ForcePersistence |
Gets or sets a value that indicates whether the message is to be persisted to the database immediately, instead of being held in memory for a short time. This property is ignored if the message is sent to a non-express queue or topic. |
IsBodyConsumed IsBodyConsumed IsBodyConsumed IsBodyConsumed |
Specifies whether the message has been consumed. |
Label Label Label Label |
Gets or sets the application specific label. |
LockedUntilUtc LockedUntilUtc LockedUntilUtc LockedUntilUtc |
Gets the date and time in UTC until which the message will be locked in the queue/subscription. |
LockToken LockToken LockToken LockToken |
Gets the lock token assigned by Service Bus to this message. |
MessageId MessageId MessageId MessageId |
Gets or sets the identifier of the message. This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled. |
PartitionKey PartitionKey PartitionKey PartitionKey |
Gets or sets a partition key for sending a transactional message to a queue or topic that is not session-aware. |
Properties Properties Properties Properties |
Gets the application specific message properties. |
ReplyTo ReplyTo ReplyTo ReplyTo |
Gets or sets the address of the queue to reply to. |
ReplyToSessionId ReplyToSessionId ReplyToSessionId ReplyToSessionId |
Gets or sets the session identifier to reply to. |
ScheduledEnqueueTimeUtc ScheduledEnqueueTimeUtc ScheduledEnqueueTimeUtc ScheduledEnqueueTimeUtc |
Gets or sets the date and time in UTC at which the message will be enqueued. This property returns the time in UTC; when setting the property, the supplied DateTime value must also be in UTC. |
SequenceNumber SequenceNumber SequenceNumber SequenceNumber |
Gets the unique number assigned to a message by the Service Bus. |
SessionId SessionId SessionId SessionId |
Gets or sets the identifier of the session. |
Size Size Size Size |
Gets the size of the message in bytes. |
State State State State |
Gets or sets the state of the message. |
TimeToLive TimeToLive TimeToLive TimeToLive |
Gets or sets the message’s time to live value. This is the duration after which the message expires, starting from when the message is sent to the Service Bus. Messages older than their TimeToLive value will expire and no longer be retained in the message store. Subscribers will be unable to receive expired messages.TimeToLive is the maximum lifetime that a message can receive, but its value cannot exceed the entity specified the DefaultMessageTimeToLive value on the destination queue or subscription. If a lower TimeToLive value is specified, it will be applied to the individual message. However, a larger value specified on the message will be overridden by the entity’s DefaultMessageTimeToLive value. |
To To To To |
Gets or sets the send to address. |
ViaPartitionKey ViaPartitionKey ViaPartitionKey ViaPartitionKey |
Gets or sets a partition key value when a transaction is to be used to send messages via a transfer queue. |
Methods
Explicit Interface Implementations
IXmlSerializable.GetSchema() IXmlSerializable.GetSchema() IXmlSerializable.GetSchema() IXmlSerializable.GetSchema() |
This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class. |
IXmlSerializable.ReadXml(XmlReader) IXmlSerializable.ReadXml(XmlReader) IXmlSerializable.ReadXml(XmlReader) IXmlSerializable.ReadXml(XmlReader) |
Generates an object from its XML representation. This method is reserved for internal use and should not be used directly or indirectly (for example, using a serializer or a formatter). |
IXmlSerializable.WriteXml(XmlWriter) IXmlSerializable.WriteXml(XmlWriter) IXmlSerializable.WriteXml(XmlWriter) IXmlSerializable.WriteXml(XmlWriter) |
Converts an object into its XML representation. This method is reserved for internal use and should not be used directly or indirectly (e.g. using a serializer or a formatter). |
Extension Methods
IsDefined(Object) IsDefined(Object) IsDefined(Object) IsDefined(Object) |
Determines if a certain property is defined or not. |
IsNull(Object) IsNull(Object) IsNull(Object) IsNull(Object) |
Determines if a certain property is null or not. |
IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object) |
Determines if a certain property is of premitive JSON type. |