Class SIPParameters

Represents a series of name value pairs that are optionally included in SIP URIs and also as an additional optional setting on some SIP Headers (Contact, To, From, Via). This class also treats the header value of a SIP URI as a special case of a SIP parameter. The difference between a parameter and a SIP URI header is the start and delimiter characters used.

Inheritance
System.Object
SIPParameters
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: SIPSorcery.SIP
Assembly: SIPSorcery.dll
Syntax
[DataContract]
public class SIPParameters

Constructors

| Improve this Doc View Source

SIPParameters(String, Char)

Parses the name value pairs from a SIP parameter or header string.

Declaration
public SIPParameters(string sipString, char delimiter)
Parameters
Type Name Description
System.String sipString
System.Char delimiter

Fields

| Improve this Doc View Source

TagDelimiter

Declaration
[DataMember]
public char TagDelimiter
Field Value
Type Description
System.Char

Properties

| Improve this Doc View Source

Count

Declaration
[IgnoreDataMember]
public int Count { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

AreEqual(SIPParameters, SIPParameters)

Declaration
public static bool AreEqual(SIPParameters params1, SIPParameters params2)
Parameters
Type Name Description
SIPParameters params1
SIPParameters params2
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CopyOf()

Declaration
public SIPParameters CopyOf()
Returns
Type Description
SIPParameters
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

Get(String)

Declaration
public string Get(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.String
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

GetKeys()

Declaration
public string[] GetKeys()
Returns
Type Description
System.String[]
| Improve this Doc View Source

GetKeyValuePairsFromQuoted(String, Char)

Declaration
public static string[] GetKeyValuePairsFromQuoted(string quotedString, char delimiter)
Parameters
Type Name Description
System.String quotedString
System.Char delimiter
Returns
Type Description
System.String[]
| Improve this Doc View Source

Has(String)

Declaration
public bool Has(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Remove(String)

Declaration
public void Remove(string name)
Parameters
Type Name Description
System.String name
| Improve this Doc View Source

RemoveAll()

Declaration
public void RemoveAll()
| Improve this Doc View Source

Set(String, String)

Declaration
public void Set(string name, string value)
Parameters
Type Name Description
System.String name
System.String value
| Improve this Doc View Source

ToString()

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

Operators

| Improve this Doc View Source

Equality(SIPParameters, SIPParameters)

Two SIPParameters objects are considered equal if they have the same keys and values. The order of the keys does not affect the equality comparison.

Declaration
public static bool operator ==(SIPParameters x, SIPParameters y)
Parameters
Type Name Description
SIPParameters x
SIPParameters y
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Inequality(SIPParameters, SIPParameters)

Declaration
public static bool operator !=(SIPParameters x, SIPParameters y)
Parameters
Type Name Description
SIPParameters x
SIPParameters y
Returns
Type Description
System.Boolean

Extension Methods