Basic Service
[Telephony Mgr]

Detailed Description

This service groups the Telephony common functions.


Data Structures

struct  _AlpNotifyEventTelDtcClosed
struct  _AlpNotifyEventTelDtcStarted
struct  _AlpNotifyEventTelNwkSsInitiated
struct  _AlpNotifyEventTelNwkSsTerminated
struct  _AlpNotifyEventTelNwkStatus
struct  _AlpNotifyEventTelNwkUssd
struct  _AlpNotifyEventTelPowConnection
struct  _AlpNotifyEventTelProvisioningFileStructure
struct  _AlpNotifyEventTelPsEventReporting
struct  _AlpNotifyEventTelSmsIncoming
struct  _AlpNotifyEventTelSpcCall
struct  _AlpNotifyEventTelVoiceMessageWaitingFlag
struct  _AlpTelEmailAddress
struct  _AlpTelMessage
struct  _AlpTelNumber
struct  _AlpTelNwkSsInfo
struct  _AlpTelPassthru
struct  _AlpTelTime

Defines

#define ALP_TEL_BASIC_CANCEL_MESSAGE   ((ALP_TEL_BASIC_SERVICE_ID << 8) | 0x0000)
#define ALP_TEL_BASIC_IS_FUNCTION_SUPPORTED_MESSAGE   ((ALP_TEL_BASIC_SERVICE_ID << 8) | 0x0003)
#define ALP_TEL_BASIC_IS_SERVICE_AVAILABLE_MESSAGE   ((ALP_TEL_BASIC_SERVICE_ID << 8) | 0x0002)
#define ALP_TEL_BASIC_MESSAGES_COUNT   ((ALP_TEL_BASIC_IS_FUNCTION_SUPPORTED_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 Total count of basic service messages.
#define ALP_TEL_BASIC_TEST_PHONE_DRIVER_MESSAGE   ((ALP_TEL_BASIC_SERVICE_ID << 8) | 0x0001)
#define ALP_TEL_IS_CANCEL_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_CANCEL_MESSAGE)
#define ALP_TEL_IS_CARD_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_CARD_SERVICE_ID)
#define ALP_TEL_IS_CAT_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_CAT_SERVICE_ID)
#define ALP_TEL_IS_CFG_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_CFG_SERVICE_ID)
#define ALP_TEL_IS_CNC_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_CNC_SERVICE_ID)
#define ALP_TEL_IS_EMC_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_EMC_SERVICE_ID)
#define ALP_TEL_IS_INF_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_INF_SERVICE_ID)
#define ALP_TEL_IS_NWK_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_NWK_SERVICE_ID)
#define ALP_TEL_IS_OEM_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_OEM_SERVICE_ID)
#define ALP_TEL_IS_PHB_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_PHB_SERVICE_ID)
#define ALP_TEL_IS_POW_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_POW_SERVICE_ID)
#define ALP_TEL_IS_PS_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_PS_SERVICE_ID)
#define ALP_TEL_IS_SMS_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_SMS_SERVICE_ID)
#define ALP_TEL_IS_SND_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_SND_SERVICE_ID)
#define ALP_TEL_IS_SPC_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_SPC_SERVICE_ID)
#define ALP_TEL_IS_STY_SERVICE_AVAILABLE(iAppId)   alp_tel_is_service_available(iAppId, ALP_TEL_STY_SERVICE_ID)
#define ALP_TEL_IS_TEST_PHONE_DRIVER_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_TEST_PHONE_DRIVER_MESSAGE)

Typedefs

typedef _AlpNotifyEventTelDtcClosed AlpNotifyEventTelDtcClosed
 Data call closed telephony notification event structure.
typedef _AlpNotifyEventTelDtcStarted AlpNotifyEventTelDtcStarted
 Data call started telephony notification event structure.
typedef _AlpNotifyEventTelNwkSsInitiated AlpNotifyEventTelNwkSsInitiated
typedef _AlpNotifyEventTelNwkSsTerminated AlpNotifyEventTelNwkSsTerminated
typedef _AlpNotifyEventTelNwkStatus AlpNotifyEventTelNwkStatus
 Network status notification event structure.
typedef _AlpNotifyEventTelNwkUssd AlpNotifyEventTelNwkUssd
 USSD notification event structure.
typedef _AlpNotifyEventTelPowConnection AlpNotifyEventTelPowConnection
 Power connection status telephony notification event structure.
typedef _AlpNotifyEventTelProvisioningFileStructure AlpNotifyEventTelProvisioningFileStructure
 Provisioning File notification event structure.
typedef _AlpNotifyEventTelPsEventReporting AlpNotifyEventTelPsEventReporting
 PS event reporting telephony notification event structure.
typedef _AlpNotifyEventTelSmsIncoming AlpNotifyEventTelSmsIncoming
 Incoming SMS telephony notification event structure.
typedef _AlpNotifyEventTelSpcCall AlpNotifyEventTelSpcCall
 Speech Call call change telephony notification event structure.
typedef _AlpNotifyEventTelVoiceMessageWaitingFlag AlpNotifyEventTelVoiceMessageWaitingFlag
 Voice message waiting flag notification event structure.
typedef void(* AlpTelCallback )(AlpTelMessage *iTelMsgP, void *iParamP)
typedef _AlpTelEmailAddress AlpTelEmailAddress
 Email address.
typedef char AlpTelISOName [2]
 ISO 639 language code.
typedef _AlpTelMessage AlpTelMessage
 Telephony Message structure.
typedef _AlpTelNumber AlpTelNumber
 Number.
typedef _AlpTelNwkSsInfo AlpTelNwkSsInfo
typedef _AlpTelPassthru AlpTelPassthru
 The passthru path.
typedef _AlpTelTime AlpTelTime
 Time.

Functions

alp_status_t alp_tel_cancel (AlpTelApplicationId iAppId, AlpTelTransId iCanceledTransId, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_close (AlpTelApplicationId iAppId)
alp_status_t alp_tel_is_function_supported (AlpTelApplicationId iAppId, uint16_t iFunctionId)
alp_status_t alp_tel_is_service_available (AlpTelApplicationId iAppId, uint16_t iServiceId)
alp_status_t alp_tel_open (uint32_t iVersionNum, AlpTelApplicationId *oAppIdP)
alp_status_t alp_tel_open_phone_profile (uint32_t iVersionNum, uint32_t iCncProfileId, AlpTelApplicationId *oAppIdP)
alp_status_t alp_tel_register_callback (AlpTelApplicationId iAppId, void *iContextP, AlpTelCallback iCallback, void *iParamP)
alp_status_t alp_tel_test_phone_driver (AlpTelApplicationId iAppId, AlpTelInfIdentification *ioNameP, AlpTelTransId *ioTransIdP)

Define Documentation

#define ALP_TEL_BASIC_CANCEL_MESSAGE   ((ALP_TEL_BASIC_SERVICE_ID << 8) | 0x0000)
 

#define ALP_TEL_BASIC_IS_FUNCTION_SUPPORTED_MESSAGE   ((ALP_TEL_BASIC_SERVICE_ID << 8) | 0x0003)
 

#define ALP_TEL_BASIC_IS_SERVICE_AVAILABLE_MESSAGE   ((ALP_TEL_BASIC_SERVICE_ID << 8) | 0x0002)
 

#define ALP_TEL_BASIC_MESSAGES_COUNT   ((ALP_TEL_BASIC_IS_FUNCTION_SUPPORTED_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 

Total count of basic service messages.

#define ALP_TEL_BASIC_TEST_PHONE_DRIVER_MESSAGE   ((ALP_TEL_BASIC_SERVICE_ID << 8) | 0x0001)
 

#define ALP_TEL_IS_CANCEL_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_CANCEL_MESSAGE)
 

#define ALP_TEL_IS_CARD_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_CARD_SERVICE_ID)
 

#define ALP_TEL_IS_CAT_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_CAT_SERVICE_ID)
 

#define ALP_TEL_IS_CFG_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_CFG_SERVICE_ID)
 

#define ALP_TEL_IS_CNC_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_CNC_SERVICE_ID)
 

#define ALP_TEL_IS_EMC_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_EMC_SERVICE_ID)
 

#define ALP_TEL_IS_INF_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_INF_SERVICE_ID)
 

#define ALP_TEL_IS_NWK_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_NWK_SERVICE_ID)
 

#define ALP_TEL_IS_OEM_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_OEM_SERVICE_ID)
 

#define ALP_TEL_IS_PHB_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_PHB_SERVICE_ID)
 

#define ALP_TEL_IS_POW_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_POW_SERVICE_ID)
 

#define ALP_TEL_IS_PS_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_PS_SERVICE_ID)
 

#define ALP_TEL_IS_SMS_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_SMS_SERVICE_ID)
 

#define ALP_TEL_IS_SND_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_SND_SERVICE_ID)
 

#define ALP_TEL_IS_SPC_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_SPC_SERVICE_ID)
 

#define ALP_TEL_IS_STY_SERVICE_AVAILABLE (  iAppId   )     alp_tel_is_service_available(iAppId, ALP_TEL_STY_SERVICE_ID)
 

#define ALP_TEL_IS_TEST_PHONE_DRIVER_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_TEST_PHONE_DRIVER_MESSAGE)
 

Typedef Documentation

typedef struct _AlpNotifyEventTelDtcClosed AlpNotifyEventTelDtcClosed
 

Data call closed telephony notification event structure.

typedef struct _AlpNotifyEventTelDtcStarted AlpNotifyEventTelDtcStarted
 

Data call started telephony notification event structure.

typedef struct _AlpNotifyEventTelNwkSsInitiated AlpNotifyEventTelNwkSsInitiated
 

typedef struct _AlpNotifyEventTelNwkSsTerminated AlpNotifyEventTelNwkSsTerminated
 

typedef struct _AlpNotifyEventTelNwkStatus AlpNotifyEventTelNwkStatus
 

Network status notification event structure.

typedef struct _AlpNotifyEventTelNwkUssd AlpNotifyEventTelNwkUssd
 

USSD notification event structure.

typedef struct _AlpNotifyEventTelPowConnection AlpNotifyEventTelPowConnection
 

Power connection status telephony notification event structure.

typedef struct _AlpNotifyEventTelProvisioningFileStructure AlpNotifyEventTelProvisioningFileStructure
 

Provisioning File notification event structure.

typedef struct _AlpNotifyEventTelPsEventReporting AlpNotifyEventTelPsEventReporting
 

PS event reporting telephony notification event structure.

typedef struct _AlpNotifyEventTelSmsIncoming AlpNotifyEventTelSmsIncoming
 

Incoming SMS telephony notification event structure.

typedef struct _AlpNotifyEventTelSpcCall AlpNotifyEventTelSpcCall
 

Speech Call call change telephony notification event structure.

typedef struct _AlpNotifyEventTelVoiceMessageWaitingFlag AlpNotifyEventTelVoiceMessageWaitingFlag
 

Voice message waiting flag notification event structure.

typedef void(* AlpTelCallback)(AlpTelMessage *iTelMsgP, void *iParamP)
 

typedef struct _AlpTelEmailAddress AlpTelEmailAddress
 

Email address.

typedef char AlpTelISOName[2]
 

ISO 639 language code.

typedef struct _AlpTelMessage AlpTelMessage
 

Telephony Message structure.

typedef struct _AlpTelNumber AlpTelNumber
 

Number.

typedef struct _AlpTelNwkSsInfo AlpTelNwkSsInfo
 

typedef struct _AlpTelPassthru AlpTelPassthru
 

The passthru path.

typedef struct _AlpTelTime AlpTelTime
 

Time.

Function Documentation

alp_status_t alp_tel_cancel (  AlpTelApplicationId  iAppId,
AlpTelTransId  iCanceledTransId,
AlpTelTransId *  ioTransIdP
) 
 

Cancels an asynchronous function call.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iCanceledTransId The transaction ID associated with the function that you are cancelling.
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK If the function has been canceled successfully.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_close (  AlpTelApplicationId  iAppId  ) 
 

Close the connection to the ALP Telephony Server.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
Returns:
ALP_STATUS_OK If the connection is closed successful.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_is_function_supported (  AlpTelApplicationId  iAppId,
uint16_t  iFunctionId
) 
 

Check if the function is supported by the phone driver.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iFunctionId The function identifier
Returns:
ALP_STATUS_OK If the function is supported.

ALP_STATUS_TEL_FEATURE_NOT_SUPPORTED Function id is invalid or not supported.

Since:
ALP iSDK 1.0

alp_status_t alp_tel_is_service_available (  AlpTelApplicationId  iAppId,
uint16_t  iServiceId
) 
 

Check if the service is supported by the phone driver.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iServiceId The service identifier
Returns:
ALP_STATUS_OK If the service id is supported.

ALP_STATUS_TEL_FEATURE_NOT_SUPPORTED Service id is invalid or not supported.

Since:
ALP iSDK 1.0

alp_status_t alp_tel_open (  uint32_t  iVersionNum,
AlpTelApplicationId *  oAppIdP
) 
 

Open the connection to the ALP Telephony Server, using the default phone profile. Returns in *oAppIdP the application ID.

Parameters:
[in] iVersionNum The version number of the Telephony Library for which your application was developed.
[out] oAppIdP A pointer to an AlpTelApplicationId. Upon return, this is the application ID that you supply as a parameter to the any other telkephony functions you call.
Returns:
ALP_STATUS_OK If the connection is opened successful.

ALP_STATUS_TEL_SETTINGS If there is a problem with the phone profile.

Since:
ALP iSDK 1.0

alp_status_t alp_tel_open_phone_profile (  uint32_t  iVersionNum,
uint32_t  iCncProfileId,
AlpTelApplicationId *  oAppIdP
) 
 

Open the connection to the ALP Telephony Server, using the specified phone profile. Returns in *oAppIdP the application ID.

Parameters:
[in] iVersionNum The version number of the Telephony Library for which your application was developed.
[in] iCncProfileId The phone profile to connect.
[out] oAppIdP A pointer to an AlpTelApplicationId. Upon return, this is the application ID that you supply as a parameter to the any other telkephony functions you call.
Returns:
ALP_STATUS_OK If the connection is opened successful.

ALP_STATUS_TEL_SETTINGS If there is a problem with the phone profile.

Since:
ALP iSDK 1.0

alp_status_t alp_tel_register_callback (  AlpTelApplicationId  iAppId,
void *  iContextP,
AlpTelCallback  iCallback,
void *  iParamP
) 
 

Register a callback to get the asynchronous replies.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iContextP GLib context. If NULL, the default GLib Context will be used.
[in] iCallback Callback of your application to handle asynchronous replies.
[in] iParamP Application parameters to attach with the callback.
Returns:
ALP_STATUS_OK Callback registered successfully.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_test_phone_driver (  AlpTelApplicationId  iAppId,
AlpTelInfIdentification *  ioNameP,
AlpTelTransId *  ioTransIdP
) 
 

Determines if the currently selected driver matches the connected phone.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioNameP 
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The currently selected driver matchs the connected phone.

ALP_STATUS_TEL_LIMITED_COMPATIBILITY The currently selected driver has a limited compatibility.

Since:
ALP iSDK 1.0

Generated on Wed Jul 30 07:06:43 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.