RealTimeEndpoint Constructors

Definition

Namespace:

Microsoft.Rtc.Signaling

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

RealTimeEndpoint(String, String)	Obsolete. Constructor when URI is supplied.
RealTimeEndpoint(String, String, Boolean)	Obsolete. Constructor when URI is supplied.
RealTimeEndpoint(String, SipTransportType, String, Boolean, Int32, String, Boolean, Boolean)	Obsolete. Creates a new instance of SipEndpoint. This endpoint is server-based. By default, use port 5060 for TCP and 5061 for TLS. To use a port other than these, the caller should set the ServerPort property before trying to register.

RealTimeEndpoint(String, String)

Caution

This constructor is obsolete. Please use public constructors taking a settings object instead.

Constructor when URI is supplied.

protected:
 RealTimeEndpoint(System::String ^ uri, System::String ^ epid);

[System.Obsolete("This constructor is obsolete. Please use public constructors taking a settings object instead.")]
protected RealTimeEndpoint (string uri, string epid);

new Microsoft.Rtc.Signaling.RealTimeEndpoint : string * string -> Microsoft.Rtc.Signaling.RealTimeEndpoint

Protected Sub New (uri As String, epid As String)

Parameters

uri

String

The URI of the owning identity of this endpoint.

epid

String

The epid to use. Can be null or empty in which case it is auto generated.

Attributes

ObsoleteAttribute

Exceptions

ArgumentException

Thrown when an argument is invalid or unable to generate an EPID for this endpoint.

ArgumentOutOfRangeException

Thrown when epid string length is too long.

RealTimeEndpoint(String, String, Boolean)

Caution

This constructor is obsolete. Please use public constructors taking a settings object instead.

Constructor when URI is supplied.

protected:
 RealTimeEndpoint(System::String ^ ownerUri, System::String ^ epid, bool disallowParameters);

[System.Obsolete("This constructor is obsolete. Please use public constructors taking a settings object instead.")]
protected RealTimeEndpoint (string ownerUri, string epid, bool disallowParameters);

new Microsoft.Rtc.Signaling.RealTimeEndpoint : string * string * bool -> Microsoft.Rtc.Signaling.RealTimeEndpoint

Protected Sub New (ownerUri As String, epid As String, disallowParameters As Boolean)

Parameters

ownerUri

String

The URI of the owning identity of this endpoint.

epid

String

The epid to use. Can be null or empty in which case it is auto generated.

disallowParameters

Boolean

True to check and throw if parameters exist.

Attributes

ObsoleteAttribute

Exceptions

ArgumentException

Thrown when an argument is invalid or unable to generate an EPID for this endpoint.

ArgumentOutOfRangeException

Thrown when epid string length is too long.

RealTimeEndpoint(String, SipTransportType, String, Boolean, Int32, String, Boolean, Boolean)

Caution

This constructor is obsolete. Please use public constructors taking a settings object instead.

Creates a new instance of SipEndpoint. This endpoint is server-based. By default, use port 5060 for TCP and 5061 for TLS. To use a port other than these, the caller should set the ServerPort property before trying to register.

protected:
 RealTimeEndpoint(System::String ^ uri, Microsoft::Rtc::Signaling::SipTransportType transportType, System::String ^ serverName, bool useAutomaticConfiguration, int serverPort, System::String ^ endpointId, bool useExclusiveConnectionForRegistration, bool retryOnRefreshFailure);

[System.Obsolete("This constructor is obsolete. Please use public constructors taking a settings object instead.")]
protected RealTimeEndpoint (string uri, Microsoft.Rtc.Signaling.SipTransportType transportType, string serverName, bool useAutomaticConfiguration, int serverPort, string endpointId, bool useExclusiveConnectionForRegistration, bool retryOnRefreshFailure);

new Microsoft.Rtc.Signaling.RealTimeEndpoint : string * Microsoft.Rtc.Signaling.SipTransportType * string * bool * int * string * bool * bool -> Microsoft.Rtc.Signaling.RealTimeEndpoint

Protected Sub New (uri As String, transportType As SipTransportType, serverName As String, useAutomaticConfiguration As Boolean, serverPort As Integer, endpointId As String, useExclusiveConnectionForRegistration As Boolean, retryOnRefreshFailure As Boolean)

Parameters

uri

String

The URI of the user identifying the endpoint.

transportType

SipTransportType

The type of transport to be used to connect to the server.

serverName

String

The name of the server to be used.

useAutomaticConfiguration

Boolean

Use a DNS configured server.

serverPort

Int32

The port to be used to connect to the server. User 0 to use default.

endpointId

String

The epid to use. Can be null.

useExclusiveConnectionForRegistration

Boolean

Indicates if the connection used for registration should not be shared with other exclusive connections.

retryOnRefreshFailure

Boolean

Attributes

ObsoleteAttribute

Exceptions

ArgumentException

One of the arguments is not valid.

ArgumentNullException

The serverName parameter is a string type with a value null.