Refer Method (RealTimeAddress, ReferStatus, IEnumerable(SignalingHeader))
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, _
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<(Of <(<'SignalingHeader>)>)>
Headers required for this Refer.
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 gives 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.