Class SIPFromHeader

The From header only has parameters, no headers. Parameters of from ...;name=value;name2=value2. Specific parameters: tag.

Inheritance

object

SIPFromHeader

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: SipLib.Core

Assembly: SipLib.dll

Syntax

public class SIPFromHeader

Constructors

SIPFromHeader(string, SIPURI, string)

Constructs a new From header object from a name, a SIPURI and a From tag value.

Declaration

public SIPFromHeader(string fromName, SIPURI fromURI, string fromTag)

Parameters

Type	Name	Description
string	fromName	Name field for the From header. Optional.
SIPURI	fromURI	SIPURI to build the From header from.
string	fromTag	From header tag parameter

Properties

FromName

Gets or sets the name field of the From header value

Declaration

public string? FromName { get; set; }

Property Value

Type	Description
string

FromParameters

Gets or sets the From header parameters

Declaration

public SIPParameters FromParameters { get; set; }

Property Value

Type	Description
SIPParameters

FromTag

Gets or sets the From tag parameter value

Declaration

public string? FromTag { get; set; }

Property Value

Type	Description
string

FromURI

Gets or sets the SIPURI portion of the From header value

Declaration

public SIPURI? FromURI { get; set; }

Property Value

Type	Description
SIPURI

FromUserField

Gets or or sets the SIPUserField object for the From header

Declaration

public SIPUserField FromUserField { get; set; }

Property Value

Type	Description
SIPUserField

Methods

ParseFromHeader(string)

Parses a string into a SIPFromHeader object.

Declaration

public static SIPFromHeader ParseFromHeader(string fromHeaderStr)

Parameters

Type	Name	Description
string	fromHeaderStr	Input string

Returns

Type	Description
SIPFromHeader	Returns a SIPFromHeader object.

ToString()

Converts this object into a From header value string

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()