public interface IBasicProperties

implements ICloneable
implements IContentHeader

Summary

Common AMQP Basic content-class headers interface, spanning the union of the functionality offered by versions 0-8, 0-8qpid and 0-9 (without WIP) 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 IModel.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.

Property Summary

Type	Name	Summary
`string`	`AppId` (rw)	creating application id
`string`	`ClusterId` (rw)	intra-cluster routing identifier
`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`	`Headers` (rw)	message header field table
`string`	`MessageId` (rw)	application message identifier
`byte`	`Priority` (rw)	message priority, 0 to 9
`string`	`ReplyTo` (rw)	destination to reply to
`PublicationAddress`	`ReplyToAddress` (rw)	Convenience property; parses ReplyTo property using PublicationAddress.Parse, and serializes it using PublicationAddress.ToString. Returns null if ReplyTo property cannot be parsed by PublicationAddress.Parse.
`AmqpTimestamp`	`Timestamp` (rw)	message timestamp
`string`	`Type` (rw)	message type name
`string`	`UserId` (rw)	creating user id

Method Summary

Name	Summary
`void ClearAppId()`	Clear the AppId property.
`void ClearClusterId()`	Clear the ClusterId property.
`void ClearContentEncoding()`	Clear the ContentEncoding property.
`void ClearContentType()`	Clear the ContentType property.
`void ClearCorrelationId()`	Clear the CorrelationId property.
`void ClearDeliveryMode()`	Clear the DeliveryMode property.
`void ClearExpiration()`	Clear the Expiration property.
`void ClearHeaders()`	Clear the Headers property.
`void ClearMessageId()`	Clear the MessageId property.
`void ClearPriority()`	Clear the Priority property.
`void ClearReplyTo()`	Clear the ReplyTo property.
`void ClearTimestamp()`	Clear the Timestamp property.
`void ClearType()`	Clear the Type property.
`void ClearUserId()`	Clear the UserId property.
`bool IsAppIdPresent()`	Returns true iff the AppId property is present.
`bool IsClusterIdPresent()`	Returns true iff the ClusterId property is present.
`bool IsContentEncodingPresent()`	Returns true iff the ContentEncoding property is present.
`bool IsContentTypePresent()`	Returns true iff the ContentType property is present.
`bool IsCorrelationIdPresent()`	Returns true iff the CorrelationId property is present.
`bool IsDeliveryModePresent()`	Returns true iff the DeliveryMode property is present.
`bool IsExpirationPresent()`	Returns true iff the Expiration property is present.
`bool IsHeadersPresent()`	Returns true iff the Headers property is present.
`bool IsMessageIdPresent()`	Returns true iff the MessageId property is present.
`bool IsPriorityPresent()`	Returns true iff the Priority property is present.
`bool IsReplyToPresent()`	Returns true iff the ReplyTo property is present.
`bool IsTimestampPresent()`	Returns true iff the Timestamp property is present.
`bool IsTypePresent()`	Returns true iff the Type property is present.
`bool IsUserIdPresent()`	Returns true iff the UserId property is present.
`void SetPersistent(bool persistent)`	Sets DeliveryMode to either persistent (2) or non-persistent (1).

Property Detail

string AppId (rw)

Summary

creating application id

string ClusterId (rw)

Summary

intra-cluster routing identifier

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 Headers (rw)

Summary

message header field table

string MessageId (rw)

Summary

application message identifier

byte Priority (rw)

Summary

message priority, 0 to 9

string ReplyTo (rw)

Summary

destination to reply to

PublicationAddress ReplyToAddress (rw)

Summary

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

AmqpTimestamp Timestamp (rw)

Summary

message timestamp

string Type (rw)

Summary

message type name

string UserId (rw)

Summary

creating user id

Method Detail

ClearAppId

void ClearAppId()

Return type	`void`

Summary

Clear the AppId property.

ClearClusterId

void ClearClusterId()

Return type	`void`

Summary

Clear the ClusterId property.

ClearContentEncoding

void ClearContentEncoding()

Return type	`void`

Summary

Clear the ContentEncoding property.

ClearContentType

void ClearContentType()

Return type	`void`

Summary

Clear the ContentType property.

ClearCorrelationId

void ClearCorrelationId()

Return type	`void`

Summary

Clear the CorrelationId property.

ClearDeliveryMode

void ClearDeliveryMode()

Return type	`void`

Summary

Clear the DeliveryMode property.

ClearExpiration

void ClearExpiration()

Return type	`void`

Summary

Clear the Expiration property.

ClearHeaders

void ClearHeaders()

Return type	`void`

Summary

Clear the Headers property.

ClearMessageId

void ClearMessageId()

Return type	`void`

Summary

Clear the MessageId property.

ClearPriority

void ClearPriority()

Return type	`void`

Summary

Clear the Priority property.

ClearReplyTo

void ClearReplyTo()

Return type	`void`

Summary

Clear the ReplyTo property.

ClearTimestamp

void ClearTimestamp()

Return type	`void`

Summary

Clear the Timestamp property.

ClearType

void ClearType()

Return type	`void`

Summary

Clear the Type property.

ClearUserId

void ClearUserId()

Return type	`void`

Summary

Clear the UserId property.

IsAppIdPresent

bool IsAppIdPresent()

Return type	`bool`

Summary

Returns true iff the AppId property is present.

IsClusterIdPresent

bool IsClusterIdPresent()

Return type	`bool`

Summary

Returns true iff the ClusterId property is present.

IsContentEncodingPresent

bool IsContentEncodingPresent()

Return type	`bool`

Summary

Returns true iff the ContentEncoding property is present.

IsContentTypePresent

bool IsContentTypePresent()

Return type	`bool`

Summary

Returns true iff the ContentType property is present.

IsCorrelationIdPresent

bool IsCorrelationIdPresent()

Return type	`bool`

Summary

Returns true iff the CorrelationId property is present.

IsDeliveryModePresent

bool IsDeliveryModePresent()

Return type	`bool`

Summary

Returns true iff the DeliveryMode property is present.

IsExpirationPresent

bool IsExpirationPresent()

Return type	`bool`

Summary

Returns true iff the Expiration property is present.

IsHeadersPresent

bool IsHeadersPresent()

Return type	`bool`

Summary

Returns true iff the Headers property is present.

IsMessageIdPresent

bool IsMessageIdPresent()

Return type	`bool`

Summary

Returns true iff the MessageId property is present.

IsPriorityPresent

bool IsPriorityPresent()

Return type	`bool`

Summary

Returns true iff the Priority property is present.

IsReplyToPresent

bool IsReplyToPresent()

Return type	`bool`

Summary

Returns true iff the ReplyTo property is present.

IsTimestampPresent

bool IsTimestampPresent()

Return type	`bool`

Summary

Returns true iff the Timestamp property is present.

IsTypePresent

bool IsTypePresent()

Return type	`bool`

Summary

Returns true iff the Type property is present.

IsUserIdPresent

bool IsUserIdPresent()

Return type	`bool`

Summary

Returns true iff the UserId property is present.

SetPersistent

void SetPersistent(bool persistent)

Return type void

Parameters

Name	Type
persistent	`bool`

Summary

Sets DeliveryMode 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 DeliveryMode to take on a value. In order to reset DeliveryMode to the default empty condition, call ClearDeliveryMode.