Class Properties

The Properties class defines the Immutable properties of the Message.

Inheritance

System.Object

Described

RestrictedDescribed

DescribedList

Properties

Inherited Members

DescribedList.HasField(Int32)

DescribedList.ResetField(Int32)

DescribedList.GetDebugString(String, Object[], Object[])

RestrictedDescribed.Descriptor

Described.Encode(ByteBuffer)

Described.Decode(ByteBuffer)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Amqp.Framing

Assembly: Amqp.Net.dll

Syntax

public sealed class Properties : DescribedList

Constructors

Properties()

Initializes a properties section.

Declaration

public Properties()

Properties

AbsoluteExpiryTime

Gets or sets the absolute-expiry-time field (index=8).

Declaration

public DateTime AbsoluteExpiryTime { get; set; }

Property Value

Type	Description
System.DateTime

ContentEncoding

Gets or sets the content-encoding field (index=7).

Declaration

public Symbol ContentEncoding { get; set; }

Property Value

Type	Description
Symbol

ContentType

Gets or sets the content-type field (index=6).

Declaration

public Symbol ContentType { get; set; }

Property Value

Type	Description
Symbol

CorrelationId

Gets or sets the correlation-id field (index=5).

Declaration

public string CorrelationId { get; set; }

Property Value

Type	Description
System.String

Remarks

The default correlation identifier type assumed by the library is string. If the application needs to process other types (ulong, uuid, or binary), it must use the Get/SetCorrelationId methods.

CreationTime

Gets or sets the creation-time field (index=9).

Declaration

public DateTime CreationTime { get; set; }

Property Value

Type	Description
System.DateTime

GroupId

Gets or sets the group-id field (index=10).

Declaration

public string GroupId { get; set; }

Property Value

Type	Description
System.String

GroupSequence

Gets or sets the group-sequence field (index=11).

Declaration

public uint GroupSequence { get; set; }

Property Value

Type	Description
System.UInt32

MessageId

Gets or sets the message-id field (index=0).

Declaration

public string MessageId { get; set; }

Property Value

Type	Description
System.String

Remarks

The default message identifier type assumed by the library is string. If the application needs to process other types (ulong, uuid, or binary), it must use the Get/SetMessageId methods.

ReplyTo

Gets or sets the reply-to field (index=4).

Declaration

public string ReplyTo { get; set; }

Property Value

Type	Description
System.String

ReplyToGroupId

Gets or sets the reply-to-group-id field (index=12).

Declaration

public string ReplyToGroupId { get; set; }

Property Value

Type	Description
System.String

Subject

Gets or sets the subject field (index=3).

Declaration

public string Subject { get; set; }

Property Value

Type	Description
System.String

To

Gets or sets the to field (index=2).

Declaration

public string To { get; set; }

Property Value

Type	Description
System.String

UserId

Gets or sets the user-id field (index=1).

Declaration

public byte[] UserId { get; set; }

Property Value

Type	Description
System.Byte[]

Methods

GetCorrelationId()

Gets the correlation identifier.

Declaration

public object GetCorrelationId()

Returns

Type	Description
System.Object	An object representing the message identifier. null if it is not set.

GetMessageId()

Gets the message identifier.

Declaration

public object GetMessageId()

Returns

Type	Description
System.Object	An object representing the message identifier. null if it is not set.

SetCorrelationId(Object)

Sets the correlation identifier. If not null, the object type must be string, Guid, ulong or byte[].

Declaration

public void SetCorrelationId(object id)

Parameters

Type	Name	Description
System.Object	id	The identifier object to set.

SetMessageId(Object)

Sets the message identifier. If not null, the object type must be string, Guid, ulong or byte[].

Declaration

public void SetMessageId(object id)

Parameters

Type	Name	Description
System.Object	id	The identifier object to set.

ToString()

Returns a string that represents the current properties object.

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()