ITPhoneEvent interface (tapi3if.h)
The ITPhoneEvent interface contains methods that retrieve the description of phone events that have occurred. When the application's implementation of the ITTAPIEventNotification::Event method indicates a TAPI_EVENT equal to TE_PHONEEVENT, the method's pEvent parameter is an IDispatch pointer for the ITPhoneEvent interface.
Note You must call the
ITTAPI::put_EventFilter method and set an event filter mask that includes TE_PHONEEVENT to enable reception of phone events. If you do not call ITTAPI::put_EventFilter, your application will not receive any events. For more information, see the
Events overview.
Inheritance
The ITPhoneEvent interface inherits from the IDispatch interface. ITPhoneEvent also has these types of members:
Methods
The ITPhoneEvent interface has these methods.
| ITPhoneEvent::get_ButtonLampId The get_ButtonLampId method returns a long value indicating which button or lamp triggered the event. This information is available only when ITPhoneEvent::get_Event returns PE_LAMPMODE or PE_BUTTON. |
| ITPhoneEvent::get_ButtonState The get_ButtonState method returns a PHONE_BUTTON_STATE value specifying the state to which the button has transitioned. This information is available only when the ITPhoneEvent::get_Event method returns PE_BUTTON. |
| ITPhoneEvent::get_Call The get_Call method returns a pointer to the ITCallInfo interface for the call object involved in the event. |
| ITPhoneEvent::get_Event The get_Event method returns a PHONE_EVENT value specifying the type of phone event that occurred. |
| ITPhoneEvent::get_HookSwitchDevice The get_HookSwitchDevice method returns a PHONE_HOOK_SWITCH_DEVICE value specifying the hookswitch device that changed state. This information is available only when the ITPhoneEvent::get_Event method returns PE_HOOKSWITCH. |
| ITPhoneEvent::get_HookSwitchState The get_HookSwitchState method returns a PHONE_HOOK_SWITCH_STATE value specifying the state to which the hookswitch has transitioned. This information is available only when the ITPhoneEvent::get_Event method returns PE_HOOKSWITCH. |
| ITPhoneEvent::get_NumberGathered The get_NumberGathered method returns a BSTR value specifying the phone number that was gathered. This information is available only when the ITPhoneEvent::get_Event method returns PE_NUMBERGATHERED. |
| ITPhoneEvent::get_Phone The get_Phone method returns a pointer to the ITPhone interface on the phone object that fired this event. |
| ITPhoneEvent::get_RingMode The get_RingMode method returns a long value specifying the ring mode to which the phone has transitioned. This information is available only when the ITPhoneEvent::get_Event method returns PE_RINGMODE. |
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | tapi3if.h (include Tapi3.h) |