Class SIPGeolocationHeader

Class for a SIP Geolocation header as defined in RFC 6442.

Inheritance

object

SIPGeolocationHeader

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 SIPGeolocationHeader

Constructors

SIPGeolocationHeader(SIPURI)

Constructs a new SIPGeolocationHeader object from a SIPURI object.

Declaration

public SIPGeolocationHeader(SIPURI Uri)

Parameters

Type	Name	Description
SIPURI	Uri	URI to use. May be a http, https, sip, sips or a cid type of URI.

Properties

GeolocationField

Gets or sets the SIPUserField object used to represent this Geolocation header.

Declaration

public SIPUserField GeolocationField { get; set; }

Property Value

Type	Description
SIPUserField

Methods

ParseGeolocationHeader(string)

Parses a Geolocation header value string and returns a list of SIPGeolocationHeader objects. Note: a Geolocation value string may contain multiple Geolocation headers with the headers separated by commas.

Declaration

public static List<SIPGeolocationHeader> ParseGeolocationHeader(string strHeaderField)

Parameters

Type	Name	Description
string	strHeaderField	Geolocation header value string to parse.

Returns

Type	Description
List<SIPGeolocationHeader>	Returns a list of SIPGeolocationHeader objects that contains one or more objects if succussful. Returns an empty list is an error occurred.

Exceptions

Type	Condition
SIPValidationException	Thrown if there was a validation error detected when parsing the user field.

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

object.ToString()