Common


Files

file  TapiCommon.h
 This file serves as a "C" header file defines functions for Tapi Common Interfaces like Callback Registration / De-registration.
It contains a sample set of function prototypes that would be required by applications.

Modules

 TelTapiRegisterClass
 TelTapiRegisterEvent
 TelTapiDeRegister
 TelTapiTunnelReq
 TelTapiGetVersionInfo

Data Structures

struct  TelTapiEvent_t

Typedefs

typedef bool(*) TelAppCallback (const TelTapiEvent_t *pTapiEvent)

Enumerations

enum  TelTapiEventClass_t {
  TAPI_EVENT_NONE = -1, TAPI_EVENT_CLASS_CALL_VOICE = 0x00, TAPI_EVENT_CLASS_CALL_DATA, TAPI_EVENT_CLASS_NETTEXT,
  TAPI_EVENT_CLASS_NETWORK, TAPI_EVENT_CLASS_SS, TAPI_EVENT_CLASS_SIM, TAPI_EVENT_CLASS_ERR,
  TAPI_EVENT_CLASS_UTIL, TAPI_EVENT_CLASS_ALL
}
enum  TelTapiEventType_t {
  TAPI_EVENT_CALL_SETUP_CNF = 1, TAPI_EVENT_CALL_ALERT_IND, TAPI_EVENT_CALL_CONNECTING_IND, TAPI_EVENT_CALL_CONNECTED_IND,
  TAPI_EVENT_CALL_INCOM_IND, TAPI_EVENT_CALL_ANSWER_CNF, TAPI_EVENT_CALL_RETRIEVE_CNF, TAPI_EVENT_CALL_RETRIEVE_IND,
  TAPI_EVENT_CALL_HOLD_IND, TAPI_EVENT_CALL_HOLD_CNF, TAPI_EVENT_CALL_TRANSFER_CNF, TAPI_EVENT_CALL_TRANSFER_IND,
  TAPI_EVENT_CALL_SETUPCONFERENCE_CNF, TAPI_EVENT_CALL_SETUPCONFERENCE_IND, TAPI_EVENT_CALL_SPLITCONFERENCE_CNF, TAPI_EVENT_CALL_SEND_DTMF_CNF,
  TAPI_EVENT_CALL_WAITING_IND, TAPI_EVENT_CALL_FORWARD_IND, TAPI_EVENT_CALL_USERINFO_IND, TAPI_EVENT_CALL_RELEASE_CNF,
  TAPI_EVENT_CALL_RELEASE_ALL_CNF, TAPI_EVENT_CALL_END_IND, TAPI_EVENT_NETTEXT_READ_SMS_CNF, TAPI_EVENT_NETTEXT_GET_COUNT_CNF,
  TAPI_EVENT_NETTEXT_SENTSTATUS_CNF, TAPI_EVENT_NETTEXT_GET_PARAM_CNF, TAPI_EVENT_NETTEXT_DELETE_STATUS_CNF, TAPI_EVENT_NETTEXT_SAVE_STATUS_CNF,
  TAPI_EVENT_NETTEXT_SET_REQUEST_CNF, TAPI_EVENT_NETTEXT_GET_CB_CONFIG_CNF, TAPI_EVENT_NETTEXT_GET_SMSBEARER_CNF, TAPI_EVENT_NETTEXT_DELIVERY_REPORT_CNF,
  TAPI_EVENT_NETTEXT_INCOM_IND, TAPI_EVENT_NETTEXT_CB_INCOM_IND, TAPI_EVENT_NETTEXT_MEMORY_STATUS_IND, TAPI_EVENT_NETWORK_SELECT_CNF,
  TAPI_EVENT_NETWORK_SEARCH_CNF, TAPI_EVENT_NETWORK_GETSELECTIONMODE_CNF, TAPI_EVENT_NETWORK_GETNETWORKINFO_CNF, TAPI_EVENT_NETWORK_CANCELMANUALSEARCH_CNF,
  TAPI_EVENT_NETWORK_CANCELMANUALSELECTION_CNF, TAPI_EVENT_NETWORK_SETNWORDER_CNF, TAPI_EVENT_NETWORK_SETNWMODE_CNF, TAPI_EVENT_NETWORK_SETSELECTIONMODE_CNF,
  TAPI_EVENT_NETWORK_SETNWBAND_CNF, TAPI_EVENT_NETWORK_SETSERVICEDOMAIN_CNF, TAPI_EVENT_NETWORK_CONFIG_CNF, TAPI_EVENT_NETWORK_CHANGE_IND,
  TAPI_EVENT_NETWORK_SEARCH_IND, TAPI_EVENT_NETWORK_RADIO_INFO_IND, TAPI_EVENT_SS_BARRING_CNF, TAPI_EVENT_SS_BARRING_CHANGEPASS_CNF,
  TAPI_EVENT_SS_BARRING_QUERYSTATUS_CNF, TAPI_EVENT_SS_FORWARD_CNF, TAPI_EVENT_SS_FORWARD_QUERYSTATUS_CNF, TAPI_EVENT_SS_WAITING_CNF,
  TAPI_EVENT_SS_WAITING_QUERYSTATUS_CNF, TAPI_EVENT_SS_USSD_CNF, TAPI_EVENT_SS_USSDCNF_RSP, TAPI_EVENT_SS_USSDCNF_NOTIFY,
  TAPI_EVENT_SS_USSD_IND_RSP, TAPI_EVENT_SS_VERIFY_PWD_CNF, TAPI_EVENT_SS_QUERYCAPABILITY_INFO_CNF, TAPI_EVENT_SS_USSD_IND,
  TAPI_EVENT_SS_USSD_IND_NOTIFY, TAPI_EVENT_SS_GET_PASSWORD_IND, TAPI_EVENT_SIM_FILE_INFO_CNF, TAPI_EVENT_SIM_READ_FILE_CNF,
  TAPI_EVENT_SIM_UPDATE_FILE_CNF, TAPI_EVENT_SIM_VERIFY_PIN_CNF, TAPI_EVENT_SIM_CHANGE_PIN_CNF, TAPI_EVENT_SIM_DISABLE_PIN_CNF,
  TAPI_EVENT_SIM_ENABLE_PIN_CNF, TAPI_EVENT_SIM_UNBLOCK_PIN_CNF, TAPI_EVENT_SIM_DISABLE_FDN_CNF, TAPI_EVENT_SIM_ENABLE_FDN_CNF,
  TAPI_EVENT_SIM_PB_STORAGE_COUNT_CNF, TAPI_EVENT_SIM_PB_ENTRY_INFO_CNF, TAPI_EVENT_SIM_PB_ACCESS_READ_CNF, TAPI_EVENT_SIM_PB_UPDATE_CNF,
  TAPI_EVENT_SIM_PB_DELETE_CNF, TAPI_EVENT_SIM_STATUS_IND, TAPI_EVENT_SIM_FDN_STATUS_IND, TAPI_EVENT_ERR_RESERVED1_IND,
  TAPI_EVENT_ERR_RESERVED2_IND, TAPI_EVENT_ERR_RESERVED3_IND, TAPI_EVENT_ERR_RESERVED4_IND, TAPI_EVENT_ERR_RESERVED5_IND,
  TAPI_EVENT_TUNNEL_INFO_CNF, TAPI_EVENT_TUNNEL_INFO_IND
}

Typedef Documentation

typedef bool(*) TelAppCallback(const TelTapiEvent_t *pTapiEvent)

This describes the application callback function which will get invoked to notify the client application about the Telephony events based on TAPI asynchronous responses / indications.

callback.jpg

Enumeration Type Documentation

enum TelTapiEventClass_t

This enumeration defines the Telephony Event Class. Class is nothing but a group of events related to a particular subsystem. Example of one Event Class is TAPI_CALL_VOICE. This becomes the first parameter of telephony notifications.

Enumerator:
TAPI_EVENT_CLASS_CALL_VOICE  Voice Call Event Class
TAPI_EVENT_CLASS_CALL_DATA  Data Call Event Class
TAPI_EVENT_CLASS_NETTEXT  Nettext (SMS/CB) Event Class
TAPI_EVENT_CLASS_NETWORK  Network Event Class
TAPI_EVENT_CLASS_SS  SS Event Class
TAPI_EVENT_CLASS_SIM  SIM Event Class
TAPI_EVENT_CLASS_ERR  Fatal error Event Class
TAPI_EVENT_CLASS_UTIL  Utility Events Class
TAPI_EVENT_CLASS_ALL  All Events Class

enum TelTapiEventType_t

This enumeration defines the event types. Each event type will be mapped to one telephony Notification Id. For Example: TAPI_EVENT_CALL_INCOM_IND is mapped to Telephony.Call.Voice.Incoming.

Enumerator:
TAPI_EVENT_CALL_SETUP_CNF  This event indicates the Call Setup request triggered
TAPI_EVENT_CALL_ALERT_IND  This event indicates the Call is in Alerting stage
TAPI_EVENT_CALL_CONNECTING_IND  This event indicates the Call is in Connecting stage
TAPI_EVENT_CALL_CONNECTED_IND  This event indicates the Call is Connected
TAPI_EVENT_CALL_INCOM_IND  This event indicates Incoming Call indication to Application
TAPI_EVENT_CALL_ANSWER_CNF  Incoming call was answered
TAPI_EVENT_CALL_RETRIEVE_CNF  This event indicates Call is retrieved from held state
TAPI_EVENT_CALL_RETRIEVE_IND  This event indicates that other party has retrieved the call from hold
TAPI_EVENT_CALL_HOLD_IND  This event indicates that other party is has put the call on hold
TAPI_EVENT_CALL_HOLD_CNF  This event indicates is call is put on hold
TAPI_EVENT_CALL_TRANSFER_CNF  This event indicates is call is explicitly transferred
TAPI_EVENT_CALL_TRANSFER_IND  Call Transfer Indication
TAPI_EVENT_CALL_SETUPCONFERENCE_CNF  This event indicates that Call is joined in a conference
TAPI_EVENT_CALL_SETUPCONFERENCE_IND  Conference setup indication
TAPI_EVENT_CALL_SPLITCONFERENCE_CNF  This event indicates Call is split from conference
TAPI_EVENT_CALL_SEND_DTMF_CNF  This event indicates the confirmation for sending DTMF Digits to the network
TAPI_EVENT_CALL_WAITING_IND  Call waiting indication
TAPI_EVENT_CALL_FORWARD_IND  This event indication for Call is forwarded
TAPI_EVENT_CALL_USERINFO_IND  This event is indicated when User Information is exchanged during the call
TAPI_EVENT_CALL_RELEASE_CNF  This event is indicated when all the calls released requested by the application
TAPI_EVENT_CALL_RELEASE_ALL_CNF  This event is indicated when all the calls released requested by the application
TAPI_EVENT_CALL_END_IND  This event indicates the Call is Ended. This event can be solicited/unsolicited.
TAPI_EVENT_NETTEXT_READ_SMS_CNF  This event is returned in response to SMS Read message
TAPI_EVENT_NETTEXT_GET_COUNT_CNF  This event is returned in response to Get Number of messages stored in SIM
TAPI_EVENT_NETTEXT_SENTSTATUS_CNF  This event is returned in response to SMS message sent
TAPI_EVENT_NETTEXT_GET_PARAM_CNF  This event is returned in response to NetText Get parameters
TAPI_EVENT_NETTEXT_DELETE_STATUS_CNF  This confirmation event is a returned indicating the delete message e status
TAPI_EVENT_NETTEXT_SAVE_STATUS_CNF  This confirmation event is a returned indicating the Save SMS into SIM status
TAPI_EVENT_NETTEXT_SET_REQUEST_CNF  This event is returned as a confirmation for SET nettext APIs
TAPI_EVENT_NETTEXT_GET_CB_CONFIG_CNF  This event is returned with Get CB configuration details
TAPI_EVENT_NETTEXT_GET_SMSBEARER_CNF  This event is returned as a response to get preferred bearer used for SMS Transport
TAPI_EVENT_NETTEXT_DELIVERY_REPORT_CNF  This event is returned in response to send delivery report
TAPI_EVENT_NETTEXT_INCOM_IND  This is an unsolicited Incoming SMS Event
TAPI_EVENT_NETTEXT_CB_INCOM_IND  This is an unsolicited Incoming cell broadcast message
TAPI_EVENT_NETTEXT_MEMORY_STATUS_IND  This event is an unsolicited event indicating SIM memory status
TAPI_EVENT_NETWORK_SELECT_CNF  This confirmation event is returned when user manually selected a network from list for Network selection
TAPI_EVENT_NETWORK_SEARCH_CNF  This event is returned as confirmation for manual Network search with the available network list
TAPI_EVENT_NETWORK_GETSELECTIONMODE_CNF  This event is returned when Get selection mode indication is received at TS
TAPI_EVENT_NETWORK_GETNETWORKINFO_CNF  This event is returned when Get network information is requested
TAPI_EVENT_NETWORK_CANCELMANUALSEARCH_CNF  This event is returned on cancellation of manual network search
TAPI_EVENT_NETWORK_CANCELMANUALSELECTION_CNF  This event is returned on cancellation of manual network selection from network list
TAPI_EVENT_NETWORK_SETNWORDER_CNF  This event is returned on setting network order
TAPI_EVENT_NETWORK_SETNWMODE_CNF  This event is returned on setting network mode
TAPI_EVENT_NETWORK_SETSELECTIONMODE_CNF  This event is returned on setting network selection mode
TAPI_EVENT_NETWORK_SETNWBAND_CNF  This event is returned on setting network band
TAPI_EVENT_NETWORK_SETSERVICEDOMAIN_CNF  This event is returned on setting network service domain
TAPI_EVENT_NETWORK_CONFIG_CNF  This event is returned on setting the network configuration at OEM
TAPI_EVENT_NETWORK_CHANGE_IND  This event is returned when Telephony server receives any indication from OEM about change in Network registration/selection/status
TAPI_EVENT_NETWORK_SEARCH_IND  This is unsolicited event indicated when TS receives any indication of Manual search indication with list
TAPI_EVENT_NETWORK_RADIO_INFO_IND  This is unsolicited event indicating Radio signal indication
TAPI_EVENT_SS_BARRING_CNF  This confirmation event is sent when Barring activation/deactivation is requested
TAPI_EVENT_SS_BARRING_CHANGEPASS_CNF  This event is returned as Barring password change confirmation
TAPI_EVENT_SS_BARRING_QUERYSTATUS_CNF  This event is returned as Barring status query confirmation
TAPI_EVENT_SS_FORWARD_CNF  This event is returned as confirmation for Forward Activation/Deactivation/Registration/Erasure
TAPI_EVENT_SS_FORWARD_QUERYSTATUS_CNF  This event is returned as confirmation for Forward Status query confirmation
TAPI_EVENT_SS_WAITING_CNF  This event is returned as confirmation for Call waiting activation/deactivation
TAPI_EVENT_SS_WAITING_QUERYSTATUS_CNF  This event is returned as Call waiting status query confirmation
TAPI_EVENT_SS_USSD_CNF  This event is returned as USSD send confirmation
TAPI_EVENT_SS_USSDCNF_RSP  This event is returned as USSD confirmation response which is sent as a response to received USSD
TAPI_EVENT_SS_USSDCNF_NOTIFY  This event is an unsolicited USSD notification
TAPI_EVENT_SS_USSD_IND_RSP  USSD Indication Response
TAPI_EVENT_SS_VERIFY_PWD_CNF  This event is sent when verify pwd response is sent to Network
TAPI_EVENT_SS_QUERYCAPABILITY_INFO_CNF  Event associated with the interrogation of supported supplementary services at OEM.
TAPI_EVENT_SS_USSD_IND  This is an unsolicited USSD indication
TAPI_EVENT_SS_USSD_IND_NOTIFY  This event is an unsolicited USSD notification
TAPI_EVENT_SS_GET_PASSWORD_IND  This event is indicated to the Application when network requests for Call barring Get password for barring operation
TAPI_EVENT_SIM_FILE_INFO_CNF  File info
TAPI_EVENT_SIM_READ_FILE_CNF  Read file
TAPI_EVENT_SIM_UPDATE_FILE_CNF  Updated file
TAPI_EVENT_SIM_VERIFY_PIN_CNF  Verified Chv
TAPI_EVENT_SIM_CHANGE_PIN_CNF  Changed Chv
TAPI_EVENT_SIM_DISABLE_PIN_CNF  Disabled Chv
TAPI_EVENT_SIM_ENABLE_PIN_CNF  Enabled Chv
TAPI_EVENT_SIM_UNBLOCK_PIN_CNF  Unblocked Chv
TAPI_EVENT_SIM_DISABLE_FDN_CNF  Disabled Fdn
TAPI_EVENT_SIM_ENABLE_FDN_CNF  Enabled Fdn
TAPI_EVENT_SIM_PB_STORAGE_COUNT_CNF  Phonebook storage count
TAPI_EVENT_SIM_PB_ENTRY_INFO_CNF  Phonebook entry information
TAPI_EVENT_SIM_PB_ACCESS_READ_CNF  Phonebook access read
TAPI_EVENT_SIM_PB_UPDATE_CNF  Phonebook update result
TAPI_EVENT_SIM_PB_DELETE_CNF  Phonebook delete result
TAPI_EVENT_SIM_STATUS_IND  Unsolicited event --- whenever there is a changes in SIM status
TAPI_EVENT_SIM_FDN_STATUS_IND  Unsolicited event --- whenever there is a changes in FDN status
TAPI_EVENT_ERR_RESERVED1_IND  This event is notified to application about some error has occurred at OEM and can be used for debugging purpose
TAPI_EVENT_ERR_RESERVED2_IND  This event is notified to application about some error has occurred at OEM and can be used for debugging purpose
TAPI_EVENT_ERR_RESERVED3_IND  This event is notified to application about some error has occurred at OEM and can be used for debugging purpose
TAPI_EVENT_ERR_RESERVED4_IND  This event is notified to application about some error has occurred at OEM and can be used for debugging purpose
TAPI_EVENT_ERR_RESERVED5_IND  This event is notified to application about some error has occurred at OEM and can be used for debugging purpose
TAPI_EVENT_TUNNEL_INFO_CNF  This confirmation event is returned for Tunnel information
TAPI_EVENT_TUNNEL_INFO_IND  This event is an unsolicited event informing about Tunnel information

Generated on Mon Mar 31 01:01:00 2008 by  doxygen 1.5.4