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

IContentHeader.ProtocolClassId

IContentHeader.ProtocolClassName

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

| Improve this Doc View Source

AppId

Application Id.

Declaration

string AppId { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc 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
System.String

| Improve this Doc View Source

ContentEncoding

MIME content encoding.

Declaration

string ContentEncoding { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ContentType

MIME content type.

Declaration

string ContentType { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

CorrelationId

Application correlation identifier.

Declaration

string CorrelationId { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

DeliveryMode

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

Declaration

byte DeliveryMode { get; set; }

Property Value

Type	Description
System.Byte

| Improve this Doc View Source

Expiration

Message expiration specification.

Declaration

string Expiration { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Headers

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

Declaration

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

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

| Improve this Doc View Source

MessageId

Application message Id.

Declaration

string MessageId { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Persistent

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

Declaration

bool Persistent { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Priority

Message priority, 0 to 9.

Declaration

byte Priority { get; set; }

Property Value

Type	Description
System.Byte

| Improve this Doc View Source

ReplyTo

Destination to reply to.

Declaration

string ReplyTo { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc 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

| Improve this Doc View Source

Timestamp

Message timestamp.

Declaration

AmqpTimestamp Timestamp { get; set; }

Property Value

Type	Description
AmqpTimestamp

| Improve this Doc View Source

Type

Message type name.

Declaration

string Type { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

UserId

User Id.

Declaration

string UserId { get; set; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

ClearAppId()

Clear the AppId property.

Declaration

void ClearAppId()

| Improve this Doc View Source

ClearClusterId()

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

Declaration

void ClearClusterId()

| Improve this Doc View Source

ClearContentEncoding()

Clear the ContentEncoding property.

Declaration

void ClearContentEncoding()

| Improve this Doc View Source

ClearContentType()

Clear the ContentType property.

Declaration

void ClearContentType()

| Improve this Doc View Source

ClearCorrelationId()

Clear the CorrelationId property.

Declaration

void ClearCorrelationId()

| Improve this Doc View Source

ClearDeliveryMode()

Clear the DeliveryMode property.

Declaration

void ClearDeliveryMode()

| Improve this Doc View Source

ClearExpiration()

Clear the Expiration property.

Declaration

void ClearExpiration()

| Improve this Doc View Source

ClearHeaders()

Clear the Headers property.

Declaration

void ClearHeaders()

| Improve this Doc View Source

ClearMessageId()

Clear the MessageId property.

Declaration

void ClearMessageId()

| Improve this Doc View Source

ClearPriority()

Clear the Priority property.

Declaration

void ClearPriority()

| Improve this Doc View Source

ClearReplyTo()

Clear the ReplyTo property.

Declaration

void ClearReplyTo()

| Improve this Doc View Source

ClearTimestamp()

Clear the Timestamp property.

Declaration

void ClearTimestamp()

| Improve this Doc View Source

ClearType()

Clear the Type property.

Declaration

void ClearType()

| Improve this Doc View Source

ClearUserId()

Clear the UserId property.

Declaration

void ClearUserId()

| Improve this Doc View Source

IsAppIdPresent()

Returns true if the AppId property is present.

Declaration

bool IsAppIdPresent()

Returns

Type	Description
System.Boolean

| Improve this Doc 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
System.Boolean

| Improve this Doc View Source

IsContentEncodingPresent()

Returns true if the ContentEncoding property is present.

Declaration

bool IsContentEncodingPresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsContentTypePresent()

Returns true if the ContentType property is present.

Declaration

bool IsContentTypePresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsCorrelationIdPresent()

Returns true if the CorrelationId property is present.

Declaration

bool IsCorrelationIdPresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsDeliveryModePresent()

Returns true if the DeliveryMode property is present.

Declaration

bool IsDeliveryModePresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsExpirationPresent()

Returns true if the Expiration property is present.

Declaration

bool IsExpirationPresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsHeadersPresent()

Returns true if the Headers property is present.

Declaration

bool IsHeadersPresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsMessageIdPresent()

Returns true if the MessageId property is present.

Declaration

bool IsMessageIdPresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsPriorityPresent()

Returns true if the Priority property is present.

Declaration

bool IsPriorityPresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsReplyToPresent()

Returns true if the ReplyTo property is present.

Declaration

bool IsReplyToPresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsTimestampPresent()

Returns true if the Timestamp property is present.

Declaration

bool IsTimestampPresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsTypePresent()

Returns true if the Type property is present.

Declaration

bool IsTypePresent()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsUserIdPresent()

Returns true if the UserId UserId property is present.

Declaration

bool IsUserIdPresent()

Returns

Type	Description
System.Boolean