Edit

SipUriParser Class

  • Reference

Definition

Namespace:
Microsoft.Rtc.Signaling
Assembly:
Microsoft.Rtc.Collaboration.dll

Provides means to parse a sip URI.

public ref class SipUriParser sealed
public sealed class SipUriParser
type SipUriParser = class
Public NotInheritable Class SipUriParser
Inheritance
Object
SipUriParser

Constructors

SipUriParser(SipUriParser)

Creates a new instance of the parser given an existing instance.
SipUriParser(String)

Creates an instance of SipUriParser from a given string.
SipUriParser(String, String)

Initializes an instance of SipUriParser.
SipUriParser(String, String, String)

Initializes an instance of SipUriParser.
SipUriParser(String, String, String, Int32)

Initializes an instance of SipUriParser.
SipUriParser(String, String, String, Int32, String)

Initializes an instance of SipUriParser.

Properties

AbsoluteUri

Gets the absolute URI.
Authority

Gets the authority.
Host

Gets or sets the host part of the URI.
HostAndPort

Gets or sets the host and port together.
HostNameType

Gets the host name type for the host specified in URI.
IsGruuUri

Gets or sets the GRUU parameter in URI.
IsLooseRouter

Gets or sets the loose router parameter (lr).
IsPortSet

Gets true if the port is set. Note that the 'Port' property returns 0 if even if the port is not set.
IsUniversalNamingConvention

Gets the Boolean value indicating whether the path is in universal naming convention (UNC) format.
MethodParameter

Gets or sets the method parameter (method).
MulticastAddressParameter

Gets or sets the multicast address parameter (maddr).
OpaquePart

Get the opaque part of URI.
OpaqueUriParameter

Gets or sets the OpaqueUriParameter for URI
Password

Gets or sets the password.
Port

Gets and sets the port number.
Query

Gets or sets the query of the absolute URI.
Scheme

Gets or sets the URI scheme as a string.
TimeToLiveParameter

Gets or sets the time to live (TTL) parameter (ttl).
TransportParameter

Gets or sets the value of the transport parameter (transport).
User

Gets or sets the User part of the Uri.
UserAtHost

Gets the 'user@host' part of the URI.
UserInfo

Gets or sets the User and password with '@' suffix.
UserParameter

Gets or sets the user parameter (user).

Methods

AddHeader(SignalingHeader)

Add a header to the URI.
AddParameter(SipUriParameter)

Add a parameter to the URI.
CheckHostName(String)

Returns the UriHostNameType enum member for a host name specified as a string.
CompareEqual(SipUriParser, SipUriParser)

Compares two URIs for equality.
CompareEqual(SipUriParser, SipUriParser, Boolean)

Compares two URIs for equality.
Equals(Object)

Compares two URIs for equality.
FindHeader(String)

Return the header specific header matching with name. Return null if no matching header found.
FindParameter(String)

Return the header specific parameter matching with name. Return null if no matching parameter found.
GetHashCode()

Returns a hash value for the current Name object.
GetHeaders()

Gets the header collection of the URI.
GetParameters()

Gets a collection of sip URI parameters. May be null if the URI cannot be parsed.
IsPhoneUri()

Helper function to determine whether the URI of this parser is a phone URI. A URI is a phone URI if it has a "tel:" scheme or if it has "sip:" scheme with the parameter 'user=phone'
RemoveHeader(SignalingHeader)

Remove a header from the URI.
RemoveParameter(SipUriParameter)

Remove a parameter from the URI.
ToString()

Gets the URI as a string.
TryParse(String, SipUriParser)

Creates a URI object from a URI string.

Operators

Equality(SipUriParser, SipUriParser)

Compares two URIs for equality.
Implicit(String to SipUriParser)

Returns the implicit conversion operator from a string to a SipUriParser object.
Inequality(SipUriParser, SipUriParser)

Compares two URIs for inequality.

Extension Methods

IsPhoneUser(SipUriParser)
TryGetConnectionTarget(SipUriParser, String)
TryGetTlsTarget(SipUriParser, String)

Applies to