BrokeredMessageProperty BrokeredMessageProperty Class

Represents the property bag for a BrokeredMessage.

Syntax

Declaration

public sealed class BrokeredMessageProperty : IMessagePropertyPublic NotInheritable Class BrokeredMessageProperty
    Implements IMessageProperty

Inheritance Hierarchy

  • BrokeredMessageProperty
    BrokeredMessageProperty

Constructors summary

Initializes a new instance of the BrokeredMessageProperty class.

Fields summary

The name used for applying the property bag to a Message when sending a message.

Properties summary

Gets or sets the type of the content.

Gets or sets the identifier of the correlation.

Gets the number of deliveries that have been made to deliver this message.

Gets or sets the date and time of the sent time in UTC.

Gets the date and time in UTC at which the message is set to expire.

Gets or sets whether to force persistence on this property.

Gets or sets the application specific label.

Gets the date and time in UTC until which the message will be locked in the queue/subscription.

Gets the lock token assigned by Service Bus to the message.

Gets the brokered message.

Gets or sets the identifier of the message.

Gets or sets a partition key for sending a transactional message to a queue or topic that is not session-aware.

Gets the properties of the brokered message.

Gets or sets the address of the queue to reply to.

Gets or sets the session identifier to reply to.

Gets or sets the date and time in UTC at which the message will be enqueued.

Gets the unique number assigned to a message by the Service Bus.

Gets or sets the identifier of the session.

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.

Gets or sets the send to address.

Gets or sets a partition key value when a transaction is to be used to send messages via a transfer queue.

Explicit Interface Implementations summary

Constructors

  • BrokeredMessageProperty()
    BrokeredMessageProperty()

    Initializes a new instance of the BrokeredMessageProperty class.

    public BrokeredMessageProperty()Public Sub New

Fields

  • Name
    Name

    The name used for applying the property bag to a Message when sending a message.

    public static readonly string NamePublic Shared ReadOnly Name As String

Properties

  • ContentType
    ContentType

    Gets or sets the type of the content.

    public string ContentType { get; set; }Public Property ContentType As String

    Property Value

    • The type of the content of the message body. This is a content type identifier utilized by the sender and receiver for application specific logic.

    Exceptions

  • CorrelationId
    CorrelationId

    Gets or sets the identifier of the correlation.

    public string CorrelationId { get; set; }Public Property CorrelationId As String

    Property Value

    Exceptions

  • DeliveryCount
    DeliveryCount

    Gets the number of deliveries that have been made to deliver this message.

    public int DeliveryCount { get; }Public ReadOnly Property DeliveryCount As Integer

    Property Value

    • The number of deliveries that have been made to deliver this message.

    Exceptions

  • EnqueuedTimeUtc
    EnqueuedTimeUtc

    Gets or sets the date and time of the sent time in UTC.

    public DateTime EnqueuedTimeUtc { get; }Public ReadOnly Property EnqueuedTimeUtc As Date

    Property Value

    • The enqueue time in UTC. This value represents the actual time of enqueuing the message.

    Exceptions

  • ExpiresAtUtc
    ExpiresAtUtc

    Gets the date and time in UTC at which the message is set to expire.

    public DateTime ExpiresAtUtc { get; }Public ReadOnly Property ExpiresAtUtc As Date

    Property Value

    Exceptions

  • ForcePersistence
    ForcePersistence

    Gets or sets whether to force persistence on this property.

    public bool ForcePersistence { get; set; }Public Property ForcePersistence As Boolean

    Property Value

    • true to force persistence on this property; otherwise, false.

  • Label
    Label

    Gets or sets the application specific label.

    public string Label { get; set; }Public Property Label As String

    Property Value

    Exceptions

  • LockedUntilUtc
    LockedUntilUtc

    Gets the date and time in UTC until which the message will be locked in the queue/subscription.

    public DateTime LockedUntilUtc { get; }Public ReadOnly Property LockedUntilUtc As Date

    Property Value

    • The date and time until which the message will be locked in the queue/subscription.

    Exceptions

  • LockToken
    LockToken

    Gets the lock token assigned by Service Bus to the message.

    public Guid LockToken { get; }Public ReadOnly Property LockToken As Guid

    Property Value

    • The lock token assigned by Service Bus to the message.

    Exceptions

  • Message
    Message

    Gets the brokered message.

    public BrokeredMessage Message { get; }Public ReadOnly Property Message As BrokeredMessage

    Property Value

  • MessageId
    MessageId

    Gets or sets the identifier of the message.

    public string MessageId { get; set; }Public Property MessageId As String

    Property Value

    Exceptions

  • PartitionKey
    PartitionKey

    Gets or sets a partition key for sending a transactional message to a queue or topic that is not session-aware.

    public string PartitionKey { get; set; }Public Property PartitionKey As String

    Property Value

  • Properties
    Properties

    Gets the properties of the brokered message.

    public IDictionary<string, object> Properties { get; }Public ReadOnly Property Properties As IDictionary(Of String, Object)

    Property Value

    Exceptions

  • ReplyTo
    ReplyTo

    Gets or sets the address of the queue to reply to.

    public string ReplyTo { get; set; }Public Property ReplyTo As String

    Property Value

    Exceptions

  • ReplyToSessionId
    ReplyToSessionId

    Gets or sets the session identifier to reply to.

    public string ReplyToSessionId { get; set; }Public Property ReplyToSessionId As String

    Property Value

  • ScheduledEnqueueTimeUtc
    ScheduledEnqueueTimeUtc

    Gets or sets the date and time in UTC at which the message will be enqueued.

    public DateTime ScheduledEnqueueTimeUtc { get; set; }Public Property ScheduledEnqueueTimeUtc As Date

    Property Value

    • The scheduled enqueue time in UTC. This value is for delayed message sending. It is utilized to delay messages sending to a specific time in the future.

    Exceptions

  • SequenceNumber
    SequenceNumber

    Gets the unique number assigned to a message by the Service Bus.

    public long SequenceNumber { get; }Public ReadOnly Property SequenceNumber As Long

    Property Value

    • The unique number assigned to a message by the Service Bus.

    Exceptions

  • SessionId
    SessionId

    Gets or sets the identifier of the session.

    public string SessionId { get; set; }Public Property SessionId As String

    Property Value

    Exceptions

  • 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.

    public TimeSpan TimeToLive { get; set; }Public Property TimeToLive As TimeSpan

    Property Value

    Exceptions

  • To
    To

    Gets or sets the send to address.

    public string To { get; set; }Public Property To As String

    Property Value

    Exceptions

  • ViaPartitionKey
    ViaPartitionKey

    Gets or sets a partition key value when a transaction is to be used to send messages via a transfer queue.

    public string ViaPartitionKey { get; set; }Public Property ViaPartitionKey As String

    Property Value

Explicit Interface Implementations

  • IMessageProperty.CreateCopy()
    System.ServiceModel.Channels.IMessageProperty.CreateCopy()
    IMessageProperty IMessageProperty.CreateCopy()Function System.ServiceModel.Channels.IMessageProperty.CreateCopy As IMessageProperty Implements IMessageProperty.CreateCopy

    Returns

Details

Assembly

Microsoft.ServiceBus.dll