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.

Namespace:  Microsoft.Rtc.Signaling
Assembly:  Microsoft.Rtc.Collaboration(in Microsoft.Rtc.Collaboration.dll)

Syntax

Visual Basic (Declaration)
Public 
Function 
Refer ( _
	
referTarget 
As 

RealTimeAddress, _
	
referStatus 
As 
ReferStatus
_
) 
As 

SipResponseData
C#
public 

SipResponseData 
Refer(
	

RealTimeAddress 
referTarget,
	
ReferStatus

referStatus
)
Visual C++
public:

SipResponseData^ 
Refer(
	

RealTimeAddress^ 
referTarget, 
	

ReferStatus^ 
referStatus
)
JavaScript
function 
refer(
referTarget, 
referStatus);

Parameters

referTarget
Type: Microsoft.Rtc.Signaling . . :: . RealTimeAddress
The session target object containing the Refer URI.
referStatus
Type: Microsoft.Rtc.Signaling . . :: . ReferStatus
The ReferStatus object that is used to signal Refer state changes.

Return Value

The response data received for the refer request.

Exceptions

Exception Condition
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.
Microsoft.Rtc.Signaling . . :: . RealTimeException Thrown when the server or remote participant returns an error. The response code in the exception should give more information.
Microsoft.Rtc.Signaling . . :: . RealTimeException Encompasses an SIP error or failure cases encountered while trying to enter the session - SIP Transport error, SIP Authentication and credential-related errors.

See Also