public interface IBasicProperties

Known direct subtypes: BasicProperties

Summary

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.

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 .

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.

Property Summary

Type Name Summary
string AppId (rw)

Application Id.

string ClusterId (rw)

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

string ContentEncoding (rw)

MIME content encoding.

string ContentType (rw)

MIME content type.

string CorrelationId (rw)

Application correlation identifier.

byte DeliveryMode (rw)

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

string Expiration (rw)

Message expiration specification.

IDictionary<string,object> Headers (rw)

Message header field table. Is of type .

string MessageId (rw)

Application message Id.

byte Priority (rw)

Message priority, 0 to 9.

string ReplyTo (rw)

Destination to reply to.

PublicationAddress ReplyToAddress (rw)

Convenience property; parses property using , and serializes it using . Returns null if property cannot be parsed by .

AmqpTimestamp Timestamp (rw)

Message timestamp.

string Type (rw)

Message type name.

string UserId (rw)

User Id.

Method Summary

Name Summary
void ClearAppId()

Clear the property.

void ClearClusterId()

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

void ClearContentEncoding()

Clear the property.

void ClearContentType()

Clear the property.

void ClearCorrelationId()

Clear the property.

void ClearDeliveryMode()

Clear the property.

void ClearExpiration()

Clear the property.

void ClearHeaders()

Clear the property.

void ClearMessageId()

Clear the property.

void ClearPriority()

Clear the property.

void ClearReplyTo()

Clear the property.

void ClearTimestamp()

Clear the property.

void ClearType()

Clear the Type property.

void ClearUserId()

Clear the property.

bool IsAppIdPresent()

Returns true if the property is present.

bool IsClusterIdPresent()

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

bool IsContentEncodingPresent()

Returns true if the property is present.

bool IsContentTypePresent()

Returns true if the property is present.

bool IsCorrelationIdPresent()

Returns true if the property is present.

bool IsDeliveryModePresent()

Returns true if the property is present.

bool IsExpirationPresent()

Returns true if the property is present.

bool IsHeadersPresent()

Returns true if the property is present.

bool IsMessageIdPresent()

Returns true if the property is present.

bool IsPriorityPresent()

Returns true if the property is present.

bool IsReplyToPresent()

Returns true if the property is present.

bool IsTimestampPresent()

Returns true if the property is present.

bool IsTypePresent()

Returns true if the Type property is present.

bool IsUserIdPresent()

Returns true if the UserId property is present.

void SetPersistent(bool persistent)

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

Property Detail

string AppId (rw)

Summary

Application Id.

string ClusterId (rw)

Summary

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

string ContentEncoding (rw)

Summary

MIME content encoding.

string ContentType (rw)

Summary

MIME content type.

string CorrelationId (rw)

Summary

Application correlation identifier.

byte DeliveryMode (rw)

Summary

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

string Expiration (rw)

Summary

Message expiration specification.

IDictionary<string,object> Headers (rw)

Summary

Message header field table. Is of type .

string MessageId (rw)

Summary

Application message Id.

byte Priority (rw)

Summary

Message priority, 0 to 9.

string ReplyTo (rw)

Summary

Destination to reply to.

PublicationAddress ReplyToAddress (rw)

Summary

Convenience property; parses property using , and serializes it using . Returns null if property cannot be parsed by .

AmqpTimestamp Timestamp (rw)

Summary

Message timestamp.

string Type (rw)

Summary

Message type name.

string UserId (rw)

Summary

User Id.

Method Detail

ClearAppId

void ClearAppId()

Return type void

Summary

Clear the property.

ClearClusterId

void ClearClusterId()

Return type void

Summary

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

ClearContentEncoding

void ClearContentEncoding()

Return type void

Summary

Clear the property.

ClearContentType

void ClearContentType()

Return type void

Summary

Clear the property.

ClearCorrelationId

void ClearCorrelationId()

Return type void

Summary

Clear the property.

ClearDeliveryMode

void ClearDeliveryMode()

Return type void

Summary

Clear the property.

ClearExpiration

void ClearExpiration()

Return type void

Summary

Clear the property.

ClearHeaders

void ClearHeaders()

Return type void

Summary

Clear the property.

ClearMessageId

void ClearMessageId()

Return type void

Summary

Clear the property.

ClearPriority

void ClearPriority()

Return type void

Summary

Clear the property.

ClearReplyTo

void ClearReplyTo()

Return type void

Summary

Clear the property.

ClearTimestamp

void ClearTimestamp()

Return type void

Summary

Clear the property.

ClearType

void ClearType()

Return type void

Summary

Clear the Type property.

ClearUserId

void ClearUserId()

Return type void

Summary

Clear the property.

IsAppIdPresent

bool IsAppIdPresent()

Return type bool

Summary

Returns true if the property is present.

IsClusterIdPresent

bool IsClusterIdPresent()

Return type bool

Summary

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

IsContentEncodingPresent

bool IsContentEncodingPresent()

Return type bool

Summary

Returns true if the property is present.

IsContentTypePresent

bool IsContentTypePresent()

Return type bool

Summary

Returns true if the property is present.

IsCorrelationIdPresent

bool IsCorrelationIdPresent()

Return type bool

Summary

Returns true if the property is present.

IsDeliveryModePresent

bool IsDeliveryModePresent()

Return type bool

Summary

Returns true if the property is present.

IsExpirationPresent

bool IsExpirationPresent()

Return type bool

Summary

Returns true if the property is present.

IsHeadersPresent

bool IsHeadersPresent()

Return type bool

Summary

Returns true if the property is present.

IsMessageIdPresent

bool IsMessageIdPresent()

Return type bool

Summary

Returns true if the property is present.

IsPriorityPresent

bool IsPriorityPresent()

Return type bool

Summary

Returns true if the property is present.

IsReplyToPresent

bool IsReplyToPresent()

Return type bool

Summary

Returns true if the property is present.

IsTimestampPresent

bool IsTimestampPresent()

Return type bool

Summary

Returns true if the property is present.

IsTypePresent

bool IsTypePresent()

Return type bool

Summary

Returns true if the Type property is present.

IsUserIdPresent

bool IsUserIdPresent()

Return type bool

Summary

Returns true if the UserId property is present.

SetPersistent

void SetPersistent(bool persistent)

Return type void
Parameters
Name Type
persistent bool

Summary

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

Remarks

The numbers 1 and 2 for delivery mode are "magic" in that they appear in the AMQP 0-8 and 0-9 specifications as part of the definition of the DeliveryMode Basic-class property, without being defined as named constants.

Calling this method causes to take on a value. In order to reset to the default empty condition, call .