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.
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 SourceAppId
Application Id.
Declaration
string AppId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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 |
ContentEncoding
MIME content encoding.
Declaration
string ContentEncoding { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ContentType
MIME content type.
Declaration
string ContentType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CorrelationId
Application correlation identifier.
Declaration
string CorrelationId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DeliveryMode
Non-persistent (1) or persistent (2).
Declaration
byte DeliveryMode { get; set; }
Property Value
Type | Description |
---|---|
System.Byte |
Expiration
Message expiration specification.
Declaration
string Expiration { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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> |
MessageId
Application message Id.
Declaration
string MessageId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Persistent
Sets DeliveryMode to either persistent (2) or non-persistent (1).
Declaration
bool Persistent { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Priority
Message priority, 0 to 9.
Declaration
byte Priority { get; set; }
Property Value
Type | Description |
---|---|
System.Byte |
ReplyTo
Destination to reply to.
Declaration
string ReplyTo { get; set; }
Property Value
Type | Description |
---|---|
System.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).
Declaration
PublicationAddress ReplyToAddress { get; set; }
Property Value
Type | Description |
---|---|
PublicationAddress |
Timestamp
Message timestamp.
Declaration
AmqpTimestamp Timestamp { get; set; }
Property Value
Type | Description |
---|---|
AmqpTimestamp |
Type
Message type name.
Declaration
string Type { get; set; }
Property Value
Type | Description |
---|---|
System.String |
UserId
User Id.
Declaration
string UserId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
| Improve this Doc View SourceClearAppId()
Clear the AppId property.
Declaration
void ClearAppId()
ClearClusterId()
Clear the ClusterId property (cluster id is deprecated in AMQP 0-9-1).
Declaration
void ClearClusterId()
ClearContentEncoding()
Clear the ContentEncoding property.
Declaration
void ClearContentEncoding()
ClearContentType()
Clear the ContentType property.
Declaration
void ClearContentType()
ClearCorrelationId()
Clear the CorrelationId property.
Declaration
void ClearCorrelationId()
ClearDeliveryMode()
Clear the DeliveryMode property.
Declaration
void ClearDeliveryMode()
ClearExpiration()
Clear the Expiration property.
Declaration
void ClearExpiration()
ClearHeaders()
Clear the Headers property.
Declaration
void ClearHeaders()
ClearMessageId()
Clear the MessageId property.
Declaration
void ClearMessageId()
ClearPriority()
Clear the Priority property.
Declaration
void ClearPriority()
ClearReplyTo()
Clear the ReplyTo property.
Declaration
void ClearReplyTo()
ClearTimestamp()
Clear the Timestamp property.
Declaration
void ClearTimestamp()
ClearType()
Clear the Type property.
Declaration
void ClearType()
ClearUserId()
Clear the UserId property.
Declaration
void ClearUserId()
IsAppIdPresent()
Returns true if the AppId property is present.
Declaration
bool IsAppIdPresent()
Returns
Type | Description |
---|---|
System.Boolean |
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 |
IsContentEncodingPresent()
Returns true if the ContentEncoding property is present.
Declaration
bool IsContentEncodingPresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsContentTypePresent()
Returns true if the ContentType property is present.
Declaration
bool IsContentTypePresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsCorrelationIdPresent()
Returns true if the CorrelationId property is present.
Declaration
bool IsCorrelationIdPresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsDeliveryModePresent()
Returns true if the DeliveryMode property is present.
Declaration
bool IsDeliveryModePresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsExpirationPresent()
Returns true if the Expiration property is present.
Declaration
bool IsExpirationPresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsHeadersPresent()
Returns true if the Headers property is present.
Declaration
bool IsHeadersPresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsMessageIdPresent()
Returns true if the MessageId property is present.
Declaration
bool IsMessageIdPresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsPriorityPresent()
Returns true if the Priority property is present.
Declaration
bool IsPriorityPresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsReplyToPresent()
Returns true if the ReplyTo property is present.
Declaration
bool IsReplyToPresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsTimestampPresent()
Returns true if the Timestamp property is present.
Declaration
bool IsTimestampPresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsTypePresent()
Returns true if the Type property is present.
Declaration
bool IsTypePresent()
Returns
Type | Description |
---|---|
System.Boolean |
IsUserIdPresent()
Returns true if the UserId UserId property is present.
Declaration
bool IsUserIdPresent()
Returns
Type | Description |
---|---|
System.Boolean |