IRTCSessionReferredEvent

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This interface retrieves information about an event of RTCE_SESSION_REFERRED. This type of event occurs when a session is transferred (referred) or a referred session is accepted.

Methods

The following tables show the methods for this interface in vtable order. This is the order in which the compiler calls the methods. This interface inherits the methods for the IUnknown and IDispatch interfaces.

The following table shows the IDispatch methods.

Method Description

IDispatch::GetIDsOfNames

Maps a single member name and an optional set of parameter names to a corresponding set of integer dispatch identifiers (DISPIDs).

These identifiers can then be used on subsequent calls to IDispatch::Invoke.

IDispatch::GetTypeInfo

Retrieves the type information for an object.

IDispatch::GetTypeInfoCount

Retrieves the number of type information interfaces provided by an object, either zero (0) or 1.

IDispatch::Invoke

Provides access to properties and methods exposed by an object.

The following table shows the IRTCSessionReferredEvent methods.

Method Description

IRTCSessionReferredEvent::Session

Gets the session that is in the process of being transferred.

IRTCSessionReferredEvent::ReferredByURI

Gets the URI of the party initiating the session transfer.

IRTCSessionReferredEvent::ReferToURI

Gets the URI of the party to whom the session is being transferred, that is, the transfer target.

IRTCSessionReferredEvent::ReferCookie

Gets the cookie containing contextual information on the session that is being transferred.

IRTCSessionReferredEvent::Accept

Accepts the transferred session.

IRTCSessionReferredEvent::Reject

Rejects the transferred session.

IRTCSessionReferredEvent::SetReferredSessionState

Sets the state of the transferred session.

Obtaining a Pointer

When the application's implementation of the IRTCEventNotification::Event method indicates an RTC_EVENT enumeration value of RTCE_SESSION_REFERRED, the method's pEvent parameter is an IDispatch pointer for the IRTCSessionReferredEvent interface.

Remarks

The RTCEF_SESSION_REFERRED event is fired when the RTC Client API receives a request (an appropriate SIP REFER message) on a connected session to transfer the call to a different endpoint.

On receiving this event, the application can either create a new call to the transfer target by calling IRTCSessionReferredEvent::Accept on the event or stay connected in the existing call and reject the transfer by calling IRTCSessionReferredEvent::Reject on the event interface.

Requirements

Header rtccore.h, rtccore.idl
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.2 and later

See Also

Reference

RTC Client API Interfaces