Class SIPFromHeader

Inheritance
System.Object
SIPFromHeader
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: SIPSorcery.SIP
Assembly: SIPSorcery.dll
Syntax
public class SIPFromHeader
Remarks

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

Constructors

| Improve this Doc View Source

SIPFromHeader(String, SIPURI, String)

Declaration
public SIPFromHeader(string fromName, SIPURI fromURI, string fromTag)
Parameters
Type Name Description
System.String fromName
SIPURI fromURI
System.String fromTag

Fields

| Improve this Doc View Source

DEFAULT_FROM_URI

Declaration
public const string DEFAULT_FROM_URI = "sip:thisis@anonymous.invalid"
Field Value
Type Description
System.String
| Improve this Doc View Source

PARAMETER_TAG

Declaration
public const string PARAMETER_TAG = "tag"
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

FromName

Declaration
public string FromName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

FromParameters

Declaration
public SIPParameters FromParameters { get; set; }
Property Value
Type Description
SIPParameters
| Improve this Doc View Source

FromTag

Declaration
public string FromTag { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

FromURI

Declaration
public SIPURI FromURI { get; set; }
Property Value
Type Description
SIPURI
| Improve this Doc View Source

FromUserField

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

Methods

| Improve this Doc View Source

FriendlyDescription()

Returns a friendly description of the caller that's suitable for humans. Leaves out all the parameters etc.

Declaration
public string FriendlyDescription()
Returns
Type Description
System.String

A string representing a friendly description of the From header.
| Improve this Doc View Source

GetDefaultSIPFromHeader(SIPSchemesEnum)

Special SIP From header that is recognised by the SIP transport classes Send methods. At send time this header will be replaced by one with IP end point details that reflect the socket the request or response was sent from.

Declaration
public static SIPFromHeader GetDefaultSIPFromHeader(SIPSchemesEnum scheme)
Parameters
Type Name Description
SIPSchemesEnum scheme
Returns
Type Description
SIPFromHeader
| Improve this Doc View Source

ParseFromHeader(String)

Declaration
public static SIPFromHeader ParseFromHeader(string fromHeaderStr)
Parameters
Type Name Description
System.String fromHeaderStr
Returns
Type Description
SIPFromHeader
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Extension Methods