Table of Contents

Interface IBasicProperties

Namespace
RabbitMQ.Client
Assembly
RabbitMQ.Client.dll

The AMQP Basic headers class interface, spanning the union of the functionality offered by versions 0-8, 0-8qpid, 0-9 and 0-9-1 of AMQP.

public interface IBasicProperties : IReadOnlyBasicProperties
Inherited Members

Remarks

Each property is readable, writable and clearable: a cleared property will not be transmitted over the wire. Properties on a fresh instance are clear by default.

Properties

AppId

Application Id.

string? AppId { get; set; }

Property Value

string

ClusterId

Intra-cluster routing identifier (cluster id is deprecated in AMQP 0-9-1).

string? ClusterId { get; set; }

Property Value

string

ContentEncoding

MIME content encoding.

string? ContentEncoding { get; set; }

Property Value

string

ContentType

MIME content type.

string? ContentType { get; set; }

Property Value

string

CorrelationId

Application correlation identifier.

string? CorrelationId { get; set; }

Property Value

string

DeliveryMode

Non-persistent (1) or persistent (2).

DeliveryModes DeliveryMode { get; set; }

Property Value

DeliveryModes

Expiration

Message expiration specification.

string? Expiration { get; set; }

Property Value

string

Headers

Message header field table. Is of type IDictionary<TKey, TValue>.

IDictionary<string, object?>? Headers { get; set; }

Property Value

IDictionary<string, object>

MessageId

Application message Id.

string? MessageId { get; set; }

Property Value

string

Persistent

Sets DeliveryMode to either persistent (2) or non-persistent (1).

bool Persistent { get; set; }

Property Value

bool

Priority

Message priority, 0 to 9.

byte Priority { get; set; }

Property Value

byte

ReplyTo

Destination to reply to.

string? ReplyTo { get; set; }

Property Value

string

ReplyToAddress

Convenience property; parses ReplyTo property using TryParse(string?, out PublicationAddress?), and serializes it using ToString(). Returns null if ReplyTo property cannot be parsed by TryParse(string?, out PublicationAddress?).

PublicationAddress? ReplyToAddress { get; set; }

Property Value

PublicationAddress

Timestamp

Message timestamp.

AmqpTimestamp Timestamp { get; set; }

Property Value

AmqpTimestamp

Type

Message type name.

string? Type { get; set; }

Property Value

string

UserId

User Id.

string? UserId { get; set; }

Property Value

string

Methods

ClearAppId()

Clear the AppId property.

void ClearAppId()

ClearClusterId()

Clear the ClusterId property (cluster id is deprecated in AMQP 0-9-1).

void ClearClusterId()

ClearContentEncoding()

Clear the ContentEncoding property.

void ClearContentEncoding()

ClearContentType()

Clear the ContentType property.

void ClearContentType()

ClearCorrelationId()

Clear the CorrelationId property.

void ClearCorrelationId()

ClearDeliveryMode()

Clear the DeliveryMode property.

void ClearDeliveryMode()

ClearExpiration()

Clear the Expiration property.

void ClearExpiration()

ClearHeaders()

Clear the Headers property.

void ClearHeaders()

ClearMessageId()

Clear the MessageId property.

void ClearMessageId()

ClearPriority()

Clear the Priority property.

void ClearPriority()

ClearReplyTo()

Clear the ReplyTo property.

void ClearReplyTo()

ClearTimestamp()

Clear the Timestamp property.

void ClearTimestamp()

ClearType()

Clear the Type property.

void ClearType()

ClearUserId()

Clear the UserId property.

void ClearUserId()