SALES: 1-800-867-1380

BrokeredMessage Properties

The BrokeredMessage type exposes the following members.

  Name Description
Public property ContentType Gets or sets the type of the content.
Public property CorrelationId Gets or sets the identifier of the correlation.
Public property DeliveryCount Gets the number of deliveries.
Public property EnqueuedSequenceNumber Gets or sets the enqueued sequence number of the message.
Public property EnqueuedTimeUtc Gets or sets the date and time of the sent time in UTC.
Public property ExpiresAtUtc Gets the date and time in UTC at which the message is set to expire.
Public property 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.
Public property IsBodyConsumed Specifies whether the message has been consumed.
Public property Label Gets or sets the application specific label.
Public property LockedUntilUtc Gets the date and time in UTC until which the message will be locked in the queue/subscription.
Public property LockToken Gets the lock token assigned by Service Bus to this message.
Public property MessageId Gets or sets the identifier of the message.
Public property PartitionKey Gets or sets a partition key for sending a transactional message to a queue or topic that is not session-aware.
Public property Properties Gets the application specific message properties.
Public property ReplyTo Gets or sets the address of the queue to reply to.
Public property ReplyToSessionId Gets or sets the session identifier to reply to.
Public property 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.
Public property SequenceNumber Gets the unique number assigned to a message by the Service Bus.
Public property SessionId Gets or sets the identifier of the session.
Public property Size Gets the size of the message in bytes.
Public property State Gets or sets the state of the message.
Public property 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.
Public property To Gets or sets the send to address.
Public property ViaPartitionKey Gets or sets a partition key value when a transaction is to be used to send messages via a transfer queue.
Top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft