IRTCSessionReferredEvent

The IRTCSessionReferredEvent interface provides methods to accept or reject a referred session.

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

Note  You must call the IRTCClient::put_EventFilter method and set an event filter mask that includes the RTCEF_SESSION_REFERRED event to enable reception of session referred events. If you do not call IRTCClient::put_EventFilter, your application will not receive any events.

Methods in Vtable Order

The IRTCSessionReferredEvent interface inherits the methods of the standard COM interfaces:

In addition, IRTCSessionReferredEvent defines the following methods.

Method Description
get_Session The session that is in the process of being transferred.
get_ReferredByURI The URI of the person initiating the session transfer.
get_ReferToURI The URI of the transfer target.
get_ReferCookie The cookie containing contextual information on the session that is being transferred.
Accept Allows the application to accept the transferred session.
Reject Allows the application to reject the transferred session.
SetReferredSessionState Allows the application to set the state of the transferred session.

Remarks

The RTCEF_SESSION_REFERRED event is fired when the RTC 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

Redistributable: Requires Rtcdll.dll on Windows 2000, Windows XP, and Windows Server 2003.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCSessionReferredEvent is defined as 176A6828-4FCC-4F28-A862-04597A6CF1C4.

See Also

Session Control Code Examples

 

Show: