SipEndpoint.Register Method

Definition

Namespace:

Microsoft.Rtc.Signaling

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

Register()	Synchronously registers the current endpoint. This method waits until the Register operation is completed. It is not recommended for a UI thread.
Register(IEnumerable<SignalingHeader>)	Synchronously registers the current endpoint. This method waits until the Register operation is completed. It is not recommended for a UI thread.

Register()

Synchronously registers the current endpoint. This method waits until the Register operation is completed. It is not recommended for a UI thread.

public:
 Microsoft::Rtc::Signaling::SipResponseData ^ Register();

public Microsoft.Rtc.Signaling.SipResponseData Register ();

member this.Register : unit -> Microsoft.Rtc.Signaling.SipResponseData

Public Function Register () As SipResponseData

Returns

SipResponseData

Returns the SipResponseData from the server after a successful Register operation.

Exceptions

InvalidOperationException

Thrown when the method is not called in the Unregistered state, or the endpoint is terminated.

RegisterException

Thrown when the registration failed.

AuthenticationException

Thrown when a general authentication-related problem occurred.

OperationTimeoutException

Thrown when server did not respond for Register request.

Register(IEnumerable<SignalingHeader>)

Synchronously registers the current endpoint. This method waits until the Register operation is completed. It is not recommended for a UI thread.

public:
 Microsoft::Rtc::Signaling::SipResponseData ^ Register(System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders);

public Microsoft.Rtc.Signaling.SipResponseData Register (System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders);

member this.Register : seq<Microsoft.Rtc.Signaling.SignalingHeader> -> Microsoft.Rtc.Signaling.SipResponseData

Public Function Register (signalingHeaders As IEnumerable(Of SignalingHeader)) As SipResponseData

Parameters

signalingHeaders

IEnumerable<SignalingHeader>

Collection of signaling headers to be included with the Register request. Can be null.

Returns

SipResponseData

Returns the SipResponseData from the server after a successful Register operation.

Exceptions

InvalidOperationException

Thrown when the method was not called in the Unregistered state, or the endpoint is terminated.

RegisterException

Thrown when the registration failed.

AuthenticationException

Thrown when a general authentication-related problem occurred.

ArgumentException

Thrown when one of the header in headers parameters is a restricted header.