Class SIPCallInfoHeader

Class for a SIP Call-Info header. See Sections 20.9 and 25.1 of RFC 3261.

Inheritance
object
SIPCallInfoHeader
Inherited Members
Namespace: SipLib.Core
Assembly: SipLib.dll
Syntax
public class SIPCallInfoHeader

Constructors

| Edit this page View Source

SIPCallInfoHeader(SIPURI, string)

Constructs a new Call-Info header object.

Declaration
public SIPCallInfoHeader(SIPURI Uri, string PurposeStr)
Parameters
Type Name Description
SIPURI Uri

Value field of the Call-Info header.
string PurposeStr

Purpose string of the header.

Fields

| Edit this page View Source

PURPOSE_PARAMETER_STRING

Defines the purpose header parameter for Call-Info.

Declaration
public const string PURPOSE_PARAMETER_STRING = "purpose"
Field Value
Type Description
string

Properties

| Edit this page View Source

CallInfoField

Gets or sets the SIPUserField object used to represent this Call-Info header.

Declaration
public SIPUserField CallInfoField { get; set; }
Property Value
Type Description
SIPUserField

May be null if not set yet.

Methods

| Edit this page View Source

ParseCallInfoHeader(string)

Parses a Call-Info header value string and returns a list of SIPCallInfoHeader objects. Note: a Call-Info value string may contain multiple Call-Info headers with the headers separated by commas.

Declaration
public static List<SIPCallInfoHeader> ParseCallInfoHeader(string HeaderStr)
Parameters
Type Name Description
string HeaderStr

Call-Info header value string to parse.
Returns
Type Description
List<SIPCallInfoHeader>

Returns a list of SIPCallInfoHeader objects that contains one or more objects if succussful. Returns an empty list is an error occurred.
Exceptions
Type Condition
SIPValidationException

Thrown if a validation error occured while parsing the SIP user field portion of the header.
| Edit this page View Source

ToString()

Converts this object into a string for use as a header value.

Declaration
public override string ToString()
Returns
Type Description
string

Returns the string value of this object.
Overrides