This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
Message (Microsoft.Rtc.Sip)
The Message class defines the abstract base class for SIP message classes. It contains a parsed SIP message, separated into its component headers and content.
The Request_OCS_ServerApi and Response_OCS_ServerApi classes inherit from this class. Objects of these types are generated by transactions (represented as a Transaction_OCS_ServerApi type or derived type, such as ClientTransaction and ServerTransaction) between two proxies.
Message headers are represented as Header objects. The collection of all headers on a message is found in the Message.AllHeaders property, which contains a HeaderCollection object. This HeaderCollection object contains all of the headers defined on the message. The content of a message is accessible through the Message.Content property.
This class implements the ICloneable interface.
The Message class is derived from the System.Object class.
Public Methods
The Message (Microsoft.Rtc.Sip) class has the following public methods.
Method |
Description |
|---|---|
Creates a copy of this Message object instance. |
|
Inherited from System.Object. Determines whether the specified System.Object is equal to the current System.Object. |
|
Inherited from System.Object. Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. |
|
Obtains an IEnumerator interface for access to a type-filtered collection of headers set on the message. |
|
Inherited from System.Object. Gets the System.Type of the current instance. |
|
Inherited from System.Object. Returns a System.String that represents the current System.Object. |
Public Properties
The Message (Microsoft.Rtc.Sip) class has the following public properties.
Property |
Description |
|---|---|
Data type: HeaderCollection Access type: Read-only Contains the message headers as a HeaderCollection object. |
|
Data type: Object type: Read-only Contains SIP stack-specific authentication information as an AuthenticationInfo (Updated) structure. |
|
Data type: String Access type: Read/write Contains the parsed message content as a string. |
|
Data type: Byte array Access type: Read/write Contains the unparsed message content in raw binary form. |
|
Data type: Boolean Access type: Read-only Indicates whether this message was received by the server (as opposed to created by the application). |
|
Data type: String Access type: Read/write Contains the string used to stamp a message. |
|
Data type: String Access type: Read-only The name of the Enterprise Edition pool in which the last stamp for this application was set. |
|
Data type: DateTime Access type: Read-only Indicates the date and time the message was received by the server. |
Requirements
Redistributable: Requires Microsoft Office Communications Server 2007.
Namespace:Microsoft.Rtc.Sip Namespace
Assembly: ServerAgent (in ServerAgent.dll)