Class BasicProperties

Namespace

RabbitMQ.Client

Assembly

RabbitMQ.Client.dll

AMQP specification content header properties for content class "basic".

public sealed class BasicProperties : IBasicProperties, IReadOnlyBasicProperties, IAmqpHeader, IAmqpWriteable

Inheritance

object

BasicProperties

Implements

IBasicProperties

IReadOnlyBasicProperties

IAmqpHeader

IAmqpWriteable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BasicProperties()

public BasicProperties()

BasicProperties(IReadOnlyBasicProperties)

public BasicProperties(IReadOnlyBasicProperties input)

Parameters

input IReadOnlyBasicProperties

Properties

AppId

Application Id.

public string? AppId { get; set; }

Property Value

string

ClusterId

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

public string? ClusterId { get; set; }

Property Value

string

ContentEncoding

MIME content encoding.

public string? ContentEncoding { get; set; }

Property Value

string

ContentType

MIME content type.

public string? ContentType { get; set; }

Property Value

string

CorrelationId

Application correlation identifier.

public string? CorrelationId { get; set; }

Property Value

string

DeliveryMode

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

public DeliveryModes DeliveryMode { get; set; }

Property Value

DeliveryModes

Expiration

Message expiration specification.

public string? Expiration { get; set; }

Property Value

string

Headers

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

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

Property Value

IDictionary<string, object>

MessageId

Application message Id.

public string? MessageId { get; set; }

Property Value

string

Persistent

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

public bool Persistent { get; set; }

Property Value

bool

Priority

Message priority, 0 to 9.

public byte Priority { get; set; }

Property Value

byte

ReplyTo

Destination to reply to.

public 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?).

public PublicationAddress? ReplyToAddress { get; set; }

Property Value

PublicationAddress

Timestamp

Message timestamp.

public AmqpTimestamp Timestamp { get; set; }

Property Value

AmqpTimestamp

Type

Message type name.

public string? Type { get; set; }

Property Value

string

UserId

User Id.

public string? UserId { get; set; }

Property Value

string

Methods

ClearAppId()

Clear the AppId property.

public void ClearAppId()

ClearClusterId()

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

public void ClearClusterId()

ClearContentEncoding()

Clear the ContentEncoding property.

public void ClearContentEncoding()

ClearContentType()

Clear the ContentType property.

public void ClearContentType()

ClearCorrelationId()

Clear the CorrelationId property.

public void ClearCorrelationId()

ClearDeliveryMode()

Clear the DeliveryMode property.

public void ClearDeliveryMode()

ClearExpiration()

Clear the Expiration property.

public void ClearExpiration()

ClearHeaders()

Clear the Headers property.

public void ClearHeaders()

ClearMessageId()

Clear the MessageId property.

public void ClearMessageId()

ClearPriority()

Clear the Priority property.

public void ClearPriority()

ClearReplyTo()

Clear the ReplyTo property.

public void ClearReplyTo()

ClearTimestamp()

Clear the Timestamp property.

public void ClearTimestamp()

ClearType()

Clear the Type property.

public void ClearType()

ClearUserId()

Clear the UserId property.

public void ClearUserId()

IsAppIdPresent()

Returns true if the AppId property is present.

public bool IsAppIdPresent()

Returns

bool

IsClusterIdPresent()

Returns true if the ClusterId property is present (cluster id is deprecated in AMQP 0-9-1).

public bool IsClusterIdPresent()

Returns

bool

IsContentEncodingPresent()

Returns true if the ContentEncoding property is present.

public bool IsContentEncodingPresent()

Returns

bool

IsContentTypePresent()

Returns true if the ContentType property is present.

public bool IsContentTypePresent()

Returns

bool

IsCorrelationIdPresent()

Returns true if the CorrelationId property is present.

public bool IsCorrelationIdPresent()

Returns

bool

IsDeliveryModePresent()

Returns true if the DeliveryMode property is present.

public bool IsDeliveryModePresent()

Returns

bool

IsExpirationPresent()

Returns true if the Expiration property is present.

public bool IsExpirationPresent()

Returns

bool

IsHeadersPresent()

Returns true if the Headers property is present.

public bool IsHeadersPresent()

Returns

bool

IsMessageIdPresent()

Returns true if the MessageId property is present.

public bool IsMessageIdPresent()

Returns

bool

IsPriorityPresent()

Returns true if the Priority property is present.

public bool IsPriorityPresent()

Returns

bool

IsReplyToPresent()

Returns true if the ReplyTo property is present.

public bool IsReplyToPresent()

Returns

bool

IsTimestampPresent()

Returns true if the Timestamp property is present.

public bool IsTimestampPresent()

Returns

bool

IsTypePresent()

Returns true if the Type property is present.

public bool IsTypePresent()

Returns

bool

IsUserIdPresent()

Returns true if the UserId property is present.

public bool IsUserIdPresent()

Returns

bool