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.
public interface IBasicProperties : IContentHeader
- Inherited Members
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
AppId
Application Id.
string AppId { get; set; }
Property Value
ClusterId
Intra-cluster routing identifier (cluster id is deprecated in AMQP 0-9-1).
string ClusterId { get; set; }
Property Value
ContentEncoding
MIME content encoding.
string ContentEncoding { get; set; }
Property Value
ContentType
MIME content type.
string ContentType { get; set; }
Property Value
CorrelationId
Application correlation identifier.
string CorrelationId { get; set; }
Property Value
DeliveryMode
Non-persistent (1) or persistent (2).
byte DeliveryMode { get; set; }
Property Value
Expiration
Message expiration specification.
string Expiration { get; set; }
Property Value
Headers
Message header field table. Is of type IDictionary<TKey, TValue>.
IDictionary<string, object> Headers { get; set; }
Property Value
MessageId
Application message Id.
string MessageId { get; set; }
Property Value
Persistent
Sets DeliveryMode to either persistent (2) or non-persistent (1).
bool Persistent { get; set; }
Property Value
Priority
Message priority, 0 to 9.
byte Priority { get; set; }
Property Value
ReplyTo
Destination to reply to.
string ReplyTo { get; set; }
Property Value
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
Timestamp
Message timestamp.
AmqpTimestamp Timestamp { get; set; }
Property Value
Type
Message type name.
string Type { get; set; }
Property Value
UserId
User Id.
string UserId { get; set; }
Property Value
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()
IsAppIdPresent()
Returns true if the AppId property is present.
bool IsAppIdPresent()
Returns
IsClusterIdPresent()
Returns true if the ClusterId property is present (cluster id is deprecated in AMQP 0-9-1).
bool IsClusterIdPresent()
Returns
IsContentEncodingPresent()
Returns true if the ContentEncoding property is present.
bool IsContentEncodingPresent()
Returns
IsContentTypePresent()
Returns true if the ContentType property is present.
bool IsContentTypePresent()
Returns
IsCorrelationIdPresent()
Returns true if the CorrelationId property is present.
bool IsCorrelationIdPresent()
Returns
IsDeliveryModePresent()
Returns true if the DeliveryMode property is present.
bool IsDeliveryModePresent()
Returns
IsExpirationPresent()
Returns true if the Expiration property is present.
bool IsExpirationPresent()
Returns
IsHeadersPresent()
Returns true if the Headers property is present.
bool IsHeadersPresent()
Returns
IsMessageIdPresent()
Returns true if the MessageId property is present.
bool IsMessageIdPresent()
Returns
IsPriorityPresent()
Returns true if the Priority property is present.
bool IsPriorityPresent()
Returns
IsReplyToPresent()
Returns true if the ReplyTo property is present.
bool IsReplyToPresent()
Returns
IsTimestampPresent()
Returns true if the Timestamp property is present.
bool IsTimestampPresent()
Returns
IsTypePresent()
Returns true if the Type property is present.
bool IsTypePresent()
Returns
IsUserIdPresent()
Returns true if the UserId UserId property is present.
bool IsUserIdPresent()