SignalingSession.Refer Method

Reference

Definition

Namespace:: Microsoft.Rtc.Signaling

Assembly:: Microsoft.Rtc.Collaboration.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Refer(RealTimeAddress, ReferStatus)	Synchronously transfers the current session to a different real-time address. This method will wait until the transfer is completed. It is not recommended for a UI thread.
Refer(RealTimeAddress, ReferStatus, IEnumerable<SignalingHeader>)	Synchronously transfers the current session to a different real-time address. This method will wait until the transfer is completed. It is not recommended for a UI thread.

Refer(RealTimeAddress, ReferStatus)

Synchronously transfers the current session to a different real-time address. This method will wait until the transfer is completed. It is not recommended for a UI thread.

public:
 Microsoft::Rtc::Signaling::SipResponseData ^ Refer(Microsoft::Rtc::Signaling::RealTimeAddress ^ referTarget, Microsoft::Rtc::Signaling::ReferStatus ^ referStatus);

public Microsoft.Rtc.Signaling.SipResponseData Refer (Microsoft.Rtc.Signaling.RealTimeAddress referTarget, Microsoft.Rtc.Signaling.ReferStatus referStatus);

member this.Refer : Microsoft.Rtc.Signaling.RealTimeAddress * Microsoft.Rtc.Signaling.ReferStatus -> Microsoft.Rtc.Signaling.SipResponseData

Parameters

referTarget: RealTimeAddress

The session target object containing the Refer URI.

referStatus: ReferStatus

The ReferStatus object that is used to signal Refer state changes.

Returns

SipResponseData

The response data received for the refer request.

Exceptions

InvalidOperationException

Thrown when the session is in an invalid state to send a Refer request.

ArgumentException

Thrown when invalid arguments are passed.

ArgumentNullException

Thrown when arguments are null.

RealTimeException

Thrown when the server or remote participant returns an error. The response code in the exception should give more information.

Applies to

Refer(RealTimeAddress, ReferStatus, IEnumerable<SignalingHeader>)

Synchronously transfers the current session to a different real-time address. This method will wait until the transfer is completed. It is not recommended for a UI thread.

public:
 Microsoft::Rtc::Signaling::SipResponseData ^ Refer(Microsoft::Rtc::Signaling::RealTimeAddress ^ referTarget, Microsoft::Rtc::Signaling::ReferStatus ^ referStatus, System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders);

public Microsoft.Rtc.Signaling.SipResponseData Refer (Microsoft.Rtc.Signaling.RealTimeAddress referTarget, Microsoft.Rtc.Signaling.ReferStatus referStatus, System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders);

member this.Refer : Microsoft.Rtc.Signaling.RealTimeAddress * Microsoft.Rtc.Signaling.ReferStatus * seq<Microsoft.Rtc.Signaling.SignalingHeader> -> Microsoft.Rtc.Signaling.SipResponseData