IRTCSessionReferredEvent
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
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 |
|---|---|
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. |
|
Retrieves the type information for an object. |
|
Retrieves the number of type information interfaces provided by an object, either zero (0) or 1. |
|
Provides access to properties and methods exposed by an object. |
The following table shows the IRTCSessionReferredEvent methods.
| Method | Description |
|---|---|
Gets the session that is in the process of being transferred. |
|
Gets the URI of the party initiating the session transfer. |
|
Gets the URI of the party to whom the session is being transferred, that is, the transfer target. |
|
Gets the cookie containing contextual information on the session that is being transferred. |
|
Accepts the transferred session. |
|
Rejects the transferred session. |
|
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 |