Refer Method (RealTimeAddress, ReferStatus)

Performs a synchronous transfer of the current session.

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

Syntax

'Declaration
Public Function Refer ( _
    referTarget As RealTimeAddress, _
    referStatus As ReferStatus _
) As SipResponseData
'Usage
Dim instance As SignalingSession
Dim referTarget As RealTimeAddress
Dim referStatus As ReferStatus
Dim returnValue As SipResponseData

returnValue = instance.Refer(referTarget, _
    referStatus)
public SipResponseData Refer(
    RealTimeAddress referTarget,
    ReferStatus referStatus
)

Parameters

Return Value

Type: Microsoft.Rtc.Signaling..::..SipResponseData
The response data received for the refer request.

Exceptions

Exception Condition
ArgumentNullException

Thrown when arguments are nullNothingnullptrunita null reference (Nothing in Visual Basic).

RealTimeException

Thrown when the server or remote participant returns an error.

The response code in the exception should give more information or encompasses an SIP error or failure cases encountered while trying to enter the session - SIP Transport error, SIP Authentication, and credential-related errors.

ArgumentException

Thrown when invalid arguments are passed.

InvalidOperationException

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

Remarks

This method waits until the transfer is completed. It is not recommended for a UI thread.

See Also

Reference

SignalingSession Class

SignalingSession Members

Refer Overload

Microsoft.Rtc.Signaling Namespace