SignalingSession.Refer Method (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.
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
- 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
Type: Microsoft.Rtc.Signaling.SipResponseData
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. |
| RealTimeException | Thrown when the server or remote participant returns an error. The response code in the exception should give more information. |