BrokeredMessage Class
Represents the unit of communication between AppFabric ServiceBus clients.
Namespace: Microsoft.ServiceBus.Messaging
Assembly: Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)
The BrokeredMessage type exposes the following members.
| Name | Description | |
|---|---|---|
 | BrokeredMessage() | Initializes a new instance of the BrokeredMessage class. |
| BrokeredMessage(Object) | Initializes a new instance of the BrokeredMessage class from a given object by using DataContractSerializer with a binary XmlDictionaryWriter. |
| BrokeredMessage(Stream, Boolean) | Initializes a new instance of the BrokeredMessage class using the supplied stream as its body. |
| BrokeredMessage(Object, XmlObjectSerializer) | Initializes a new instance of the BrokeredMessage class from a given object using the provided XmlObjectSerializer. |
| Name | Description | |
|---|---|---|
| ContentType | Gets or sets the type of the content. |
| CorrelationId | Gets or sets the identifier of the correlation. |
| DeliveryCount | Gets the number of deliveries. |
| EnqueuedSequenceNumber | Gets or sets the enqueued sequence number of the message. |
| EnqueuedTimeUtc | Gets or sets the date and time of the sent time in UTC. |
| ExpiresAtUtc | Gets the date and time in UTC at which the message is set to expire. |
| IsBodyConsumed | Specifies whether the message has been consumed. |
| Label | Gets or sets the application specific label. |
| LockedUntilUtc | Gets the date and time in UTC until which the message will be locked in the queue/subscription. |
| LockToken | Gets the lock token assigned by Service Bus to this message. |
| MessageId | Gets or sets the identifier of the message. |
| Properties | Gets the application specific message properties. |
| ReplyTo | Gets or sets the address of the queue to reply to. |
| ReplyToSessionId | Gets or sets the session identifier to reply to. |
| 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 | Gets the unique number assigned to a message by the Service Bus. |
| SessionId | Gets or sets the identifier of the session. |
| Size | Gets the size of the message in bytes. |
| State | Gets or sets the message of the state. |
| 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. |
| To | Gets or sets the send to address. |
| Name | Description | |
|---|---|---|
| Abandon() | Abandons the lock on a peek-locked message. |
| Abandon(IDictionary<String, Object>) | Abandons the lock on a peek-locked message. |
| AbandonAsync() | Asynchronously abandons the lock on a peek-locked message. |
| AbandonAsync(IDictionary<String, Object>) | Asynchronously abandons the lock on a peek-locked message. |
| BeginAbandon(AsyncCallback, Object) | Begins an asynchronous operation to abandon the lock on a peek-locked message. |
| BeginAbandon(IDictionary<String, Object>, AsyncCallback, Object) | Begins an asynchronous operation to abandon the lock on a peek-locked message. |
| BeginComplete | Begins an asynchronous operation to complete a message. |
| BeginDeadLetter(AsyncCallback, Object) | Begins an asynchronous operation to move the message to the dead letter queue. |
| BeginDeadLetter(IDictionary<String, Object>, AsyncCallback, Object) | Begins an asynchronous operation to move the message to the dead letter queue. |
| BeginDeadLetter(String, String, AsyncCallback, Object) | Begins an asynchronous operation to move the message to the dead letter queue. |
| BeginDefer(AsyncCallback, Object) | Begins an asynchronous operation to defer a message. |
| BeginDefer(IDictionary<String, Object>, AsyncCallback, Object) | Begins an asynchronous operation to defer a message. |
| BeginRenewLock | Begins an asynchronous operation to renew lock on a message. |
| Clone | Clones a message, so that it is possible to send a clone of a message as a new message. |
| Complete | Completes the receive operation of a message and indicates that the message should be marked as processed and deleted or archived. |
| CompleteAsync | Asynchronously completes the receive operation of a message and indicates that the message should be marked as processed and deleted or archived. |
| DeadLetter() | Moves the message to the dead letter queue. |
| DeadLetter(IDictionary<String, Object>) | Moves the message to the dead letter queue. |
| DeadLetter(String, String) | Moves the message to the dead letter queue. |
| DeadLetterAsync() | Asynchronously moves the message to the dead letter queue. |
| DeadLetterAsync(IDictionary<String, Object>) | Asynchronously moves the message to the dead letter queue. |
| DeadLetterAsync(String, String) | Asynchronously moves the message to the dead letter queue. |
| Defer() | Indicates that the receiver wants to defer the processing for this message. |
| Defer(IDictionary<String, Object>) | Indicates that the receiver wants to defer the processing for this message. |
| DeferAsync() | Asynchronously indicates that the receiver wants to defer the processing for this message. |
| DeferAsync(IDictionary<String, Object>) | Asynchronously indicates that the receiver wants to defer the processing for this message. |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| EndAbandon | Ends an asynchronous request to abandon the lock on a peek-locked message. |
| EndComplete | Ends an asynchronous operation to complete a message. |
| EndDeadLetter | Ends an asynchronous request to move the message to the dead letter queue. |
| EndDefer | Ends an asynchronous request to defer a message. |
| EndRenewLock | Ends an asynchronous request to renew lock on a message. |
| Equals | (Inherited from Object.) |
| GetBody<T>() | Deserializes the brokered message body into an object of the specified type by using the DataContractSerializer with a binary XmlDictionaryReader. |
| GetBody<T>(XmlObjectSerializer) | Deserializes the brokered message body into an object of the specified type by using the supplied XmlObjectSerializer. |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| RenewLock | Renews the lock on a message. |
| RenewLockAsync | Asynchronously renews the lock on a message. |
| ToString | Returns a string that represents the current message. (Overrides Object.ToString().) |
| Name | Description | |
|---|---|---|
| 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 | Generates an object from 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). |
| IXmlSerializable.WriteXml | 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). |
