Interface IBasicProperties

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

Inherited Members
Namespace: RabbitMQ.Client
Assembly: Apigen.dll
Syntax
public interface IBasicProperties : IContentHeader
Remarks

The specification code generator provides protocol-version-specific implementations of this interface. To obtain an implementation of this interface in a protocol-version-neutral way, use CreateBasicProperties().

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

| Edit this page View Source

AppId

Application Id.

Declaration
string AppId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ClusterId

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

Declaration
string ClusterId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ContentEncoding

MIME content encoding.

Declaration
string ContentEncoding { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ContentType

MIME content type.

Declaration
string ContentType { get; set; }
Property Value
Type Description
string
| Edit this page View Source

CorrelationId

Application correlation identifier.

Declaration
string CorrelationId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

DeliveryMode

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

Declaration
byte DeliveryMode { get; set; }
Property Value
Type Description
byte
| Edit this page View Source

Expiration

Message expiration specification.

Declaration
string Expiration { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Headers

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

Declaration
IDictionary<string, object> Headers { get; set; }
Property Value
Type Description
IDictionary<string, object>
| Edit this page View Source

MessageId

Application message Id.

Declaration
string MessageId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Persistent

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

Declaration
bool Persistent { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Priority

Message priority, 0 to 9.

Declaration
byte Priority { get; set; }
Property Value
Type Description
byte
| Edit this page View Source

ReplyTo

Destination to reply to.

Declaration
string ReplyTo { get; set; }
Property Value
Type Description
string
| Edit this page View Source

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

Declaration
PublicationAddress ReplyToAddress { get; set; }
Property Value
Type Description
PublicationAddress
| Edit this page View Source

Timestamp

Message timestamp.

Declaration
AmqpTimestamp Timestamp { get; set; }
Property Value
Type Description
AmqpTimestamp
| Edit this page View Source

Type

Message type name.

Declaration
string Type { get; set; }
Property Value
Type Description
string
| Edit this page View Source

UserId

User Id.

Declaration
string UserId { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

ClearAppId()

Clear the AppId property.

Declaration
void ClearAppId()
| Edit this page View Source

ClearClusterId()

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

Declaration
void ClearClusterId()
| Edit this page View Source

ClearContentEncoding()

Clear the ContentEncoding property.

Declaration
void ClearContentEncoding()
| Edit this page View Source

ClearContentType()

Clear the ContentType property.

Declaration
void ClearContentType()
| Edit this page View Source

ClearCorrelationId()

Clear the CorrelationId property.

Declaration
void ClearCorrelationId()
| Edit this page View Source

ClearDeliveryMode()

Clear the DeliveryMode property.

Declaration
void ClearDeliveryMode()
| Edit this page View Source

ClearExpiration()

Clear the Expiration property.

Declaration
void ClearExpiration()
| Edit this page View Source

ClearHeaders()

Clear the Headers property.

Declaration
void ClearHeaders()
| Edit this page View Source

ClearMessageId()

Clear the MessageId property.

Declaration
void ClearMessageId()
| Edit this page View Source

ClearPriority()

Clear the Priority property.

Declaration
void ClearPriority()
| Edit this page View Source

ClearReplyTo()

Clear the ReplyTo property.

Declaration
void ClearReplyTo()
| Edit this page View Source

ClearTimestamp()

Clear the Timestamp property.

Declaration
void ClearTimestamp()
| Edit this page View Source

ClearType()

Clear the Type property.

Declaration
void ClearType()
| Edit this page View Source

ClearUserId()

Clear the UserId property.

Declaration
void ClearUserId()
| Edit this page View Source

IsAppIdPresent()

Returns true if the AppId property is present.

Declaration
bool IsAppIdPresent()
Returns
Type Description
bool
| Edit this page View Source

IsClusterIdPresent()

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

Declaration
bool IsClusterIdPresent()
Returns
Type Description
bool
| Edit this page View Source

IsContentEncodingPresent()

Returns true if the ContentEncoding property is present.

Declaration
bool IsContentEncodingPresent()
Returns
Type Description
bool
| Edit this page View Source

IsContentTypePresent()

Returns true if the ContentType property is present.

Declaration
bool IsContentTypePresent()
Returns
Type Description
bool
| Edit this page View Source

IsCorrelationIdPresent()

Returns true if the CorrelationId property is present.

Declaration
bool IsCorrelationIdPresent()
Returns
Type Description
bool
| Edit this page View Source

IsDeliveryModePresent()

Returns true if the DeliveryMode property is present.

Declaration
bool IsDeliveryModePresent()
Returns
Type Description
bool
| Edit this page View Source

IsExpirationPresent()

Returns true if the Expiration property is present.

Declaration
bool IsExpirationPresent()
Returns
Type Description
bool
| Edit this page View Source

IsHeadersPresent()

Returns true if the Headers property is present.

Declaration
bool IsHeadersPresent()
Returns
Type Description
bool
| Edit this page View Source

IsMessageIdPresent()

Returns true if the MessageId property is present.

Declaration
bool IsMessageIdPresent()
Returns
Type Description
bool
| Edit this page View Source

IsPriorityPresent()

Returns true if the Priority property is present.

Declaration
bool IsPriorityPresent()
Returns
Type Description
bool
| Edit this page View Source

IsReplyToPresent()

Returns true if the ReplyTo property is present.

Declaration
bool IsReplyToPresent()
Returns
Type Description
bool
| Edit this page View Source

IsTimestampPresent()

Returns true if the Timestamp property is present.

Declaration
bool IsTimestampPresent()
Returns
Type Description
bool
| Edit this page View Source

IsTypePresent()

Returns true if the Type property is present.

Declaration
bool IsTypePresent()
Returns
Type Description
bool
| Edit this page View Source

IsUserIdPresent()

Returns true if the UserId UserId property is present.

Declaration
bool IsUserIdPresent()
Returns
Type Description
bool