Share via

SignalingSession.Refer Method (RealTimeAddress, ReferStatus, Generic IEnumerable)

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

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

public SipResponseData Refer (
    RealTimeAddress referTarget,
    ReferStatus referStatus,
    IEnumerable<SignalingHeader> signalingHeaders
)

Parameters

  • referTarget
    The session target object containing the address of the Refer target.
  • referStatus
    The Refer status object that is used to signal Refer state changes.
  • signalingHeaders
    Headers required for this Refer.

Return Value

The response data received for the refer request.

Exceptions

Exception type Condition
ArgumentNullException

Thrown when arguments are null.
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.

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

SignalingSession Class
SignalingSession Members
Microsoft.Rtc.Signaling Namespace