Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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, _
signalingHeaders As IEnumerable(Of SignalingHeader) _
) As SipResponseData
'Usage
Dim instance As SignalingSession
Dim referTarget As RealTimeAddress
Dim referStatus As ReferStatus
Dim signalingHeaders As IEnumerable(Of SignalingHeader)
Dim returnValue As SipResponseData
returnValue = instance.Refer(referTarget, _
referStatus, signalingHeaders)
public SipResponseData Refer(
RealTimeAddress referTarget,
ReferStatus referStatus,
IEnumerable<SignalingHeader> signalingHeaders
)
Parameters
- referTarget
Type: Microsoft.Rtc.Signaling.RealTimeAddress
The session target object containing the address of the Refer target.
- referStatus
Type: Microsoft.Rtc.Signaling.ReferStatus
The Refer status object that is used to signal Refer state changes.
- signalingHeaders
Type: System.Collections.Generic.IEnumerable<SignalingHeader>
Headers required for this Refer.
Return Value
Type: Microsoft.Rtc.Signaling.SipResponseData
The response data received for the refer request. Can be null.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | Thrown when this method is invoked multiple times using the same result. |
| ArgumentNullException | Thrown when the referTarget or referStatus parameters are null. |
| ArgumentException | Thrown when the referTarget parameter is invalid. |
| OperationTimeoutException | Thrown when this operation timed out. |
| RealTimeException | Thrown when any of the sub operations of this operation failed due to SIP related errors like connection failure, Authentication failure. |