Message (MSPL)
The Message built-in class defines a basic SIP message type, and contains the parsed To and From headers along with the content block and the associated transaction. This class serves as the base parent class for the Request and Response classes.
Syntax
class Message {
string From;
string To;
string Content;
bool Authenticated;
Transaction Transaction;
MessageOrigin Origin;
string Stamp;
string StampPool;
}
Fields
The Message class defines the following fields.
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From | Data type: string Contains the value specified in the From header of the SIP message, represented as a Unicode string. This field contains the SIP address of the sender, along with any associated parameters. |
||||||||||
To | Data type: string Contains the value specified in the To header of the SIP message, represented as a Unicode string. This field commonly contains the SIP address (or addresses) of the recipient (or recipients), along with any associated parameters. |
||||||||||
Content | Data type: string Contains the data in the Content header, represented as a string. |
||||||||||
Authenticated | Data type: bool Specifies |
||||||||||
Transaction | Data type: Transaction Contains the Transaction class associated with this message. |
||||||||||
Origin | Data type: MessageOrigin Specifies the origin of a SIP message. It may have one of the following values:
|
||||||||||
Stamp | Data type: string Marks a message with the supplied string, which can be read by either this application or downstream instances of this application. |
||||||||||
StampPool | Data type: string Retrieves the name of the server pool in which the last stamp for this application was set. |