Information Service
[Telephony Mgr]

Detailed Description

This service groups the Telephony information functions.


Data Structures

struct  _AlpTelInfCall
struct  _AlpTelInfCallsDuration
struct  _AlpTelInfCallsList
struct  _AlpTelInfIdentification
struct  _AlpTelInfPricePerUnit

Defines

#define ALP_TEL_INF_CALL_TYPE_DIALED   2
#define ALP_TEL_INF_CALL_TYPE_MISSED   0
#define ALP_TEL_INF_CALL_TYPE_RECEIVED   1
#define ALP_TEL_INF_GET_ACCUMULATED_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0006)
#define ALP_TEL_INF_GET_CALLS_DURATION_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0001)
#define ALP_TEL_INF_GET_CALLS_LIST_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0003)
#define ALP_TEL_INF_GET_CURRENT_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0005)
#define ALP_TEL_INF_GET_IDENTIFICATION_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0000)
#define ALP_TEL_INF_GET_MAX_ACCUMULATED_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0008)
#define ALP_TEL_INF_GET_PRICE_PER_UNIT_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x000A)
#define ALP_TEL_INF_MESSAGES_COUNT   ((ALP_TEL_INF_SET_PRICE_PER_UNIT_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 Total count of information service messages.
#define ALP_TEL_INF_PHONE_INFORMATION_MAX_SIZE   128
#define ALP_TEL_INF_PHONE_MANUFACTURER   0
 Phone information type: phone manufacturer.
#define ALP_TEL_INF_PHONE_MODEL   1
 Phone information type: phone model.
#define ALP_TEL_INF_PHONE_REVISION   2
 Phone information type: phone revision.
#define ALP_TEL_INF_PHONE_SERIAL_NUMBER   3
 Phone information type: phone serial number.
#define ALP_TEL_INF_RESET_ACCUMULATED_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0007)
#define ALP_TEL_INF_RESET_CALLS_DURATION_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0002)
#define ALP_TEL_INF_RESET_CALLS_LIST_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0004)
#define ALP_TEL_INF_SET_MAX_ACCUMULATED_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0009)
#define ALP_TEL_INF_SET_PRICE_PER_UNIT_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x000B)
#define ALP_TEL_INF_SUBSCRIBER_IDENTITY   4
 Phone information type: subscriber identity.
#define ALP_TEL_IS_INF_GET_ACCUMULATED_CALL_METER_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_ACCUMULATED_CALL_METER_MESSAGE)
#define ALP_TEL_IS_INF_GET_CALLS_DURATION_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_CALLS_DURATION_MESSAGE)
#define ALP_TEL_IS_INF_GET_CALLS_LIST_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_CALLS_LIST_MESSAGE)
#define ALP_TEL_IS_INF_GET_CURRENT_CALL_METER_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_CURRENT_CALL_METER_MESSAGE)
#define ALP_TEL_IS_INF_GET_IDENTIFICATION_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_IDENTIFICATION_MESSAGE)
#define ALP_TEL_IS_INF_GET_MAX_ACCUMULATED_CALL_METER_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_MAX_ACCUMULATED_CALL_METER_MESSAGE)
#define ALP_TEL_IS_INF_GET_PRICE_PER_UNIT_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_PRICE_PER_UNIT_MESSAGE)
#define ALP_TEL_IS_INF_RESET_ACCUMULATED_CALL_METER_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_RESET_ACCUMULATED_CALL_METER_MESSAGE)
#define ALP_TEL_IS_INF_RESET_CALLS_DURATION_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_RESET_CALLS_DURATION_MESSAGE)
#define ALP_TEL_IS_INF_RESET_CALLS_LIST_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_RESET_CALLS_LIST_MESSAGE)
#define ALP_TEL_IS_INF_SET_MAX_ACCUMULATED_CALL_METER_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_SET_MAX_ACCUMULATED_CALL_METER_MESSAGE)
#define ALP_TEL_IS_INF_SET_PRICE_PER_UNIT_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_INF_SET_PRICE_PER_UNIT_MESSAGE)

Typedefs

typedef _AlpTelInfCall AlpTelInfCall
typedef _AlpTelInfCallsDuration AlpTelInfCallsDuration
typedef _AlpTelInfCallsList AlpTelInfCallsList
typedef _AlpTelInfIdentification AlpTelInfIdentification
typedef _AlpTelInfPricePerUnit AlpTelInfPricePerUnit

Functions

alp_status_t alp_tel_inf_get_accumulated_call_meter (AlpTelApplicationId iAppId, uint32_t *oAccumulatedCallMeterP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_get_calls_duration (AlpTelApplicationId iAppId, AlpTelInfCallsDuration *ioCallsDurationP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_get_calls_list (AlpTelApplicationId iAppId, AlpTelInfCallsList *ioCallsListP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_get_current_call_meter (AlpTelApplicationId iAppId, uint32_t *oCurrentCallMeterP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_get_identification (AlpTelApplicationId iAppId, AlpTelInfIdentification *ioIdentificationP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_get_max_accumulated_call_meter (AlpTelApplicationId iAppId, uint32_t *oMaxAccumulatedCallMeterP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_get_price_per_unit (AlpTelApplicationId iAppId, AlpTelInfPricePerUnit *oPricePerUnitP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_reset_accumulated_call_meter (AlpTelApplicationId iAppId, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_reset_calls_duration (AlpTelApplicationId iAppId, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_reset_calls_list (AlpTelApplicationId iAppId, uint8_t iCallType, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_set_max_accumulated_call_meter (AlpTelApplicationId iAppId, uint32_t iMaxAccumulatedCallMeter, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_inf_set_price_per_unit (AlpTelApplicationId iAppId, AlpTelInfPricePerUnit *iPricePerUnitP, AlpTelTransId *ioTransIdP)

Define Documentation

#define ALP_TEL_INF_CALL_TYPE_DIALED   2
 

#define ALP_TEL_INF_CALL_TYPE_MISSED   0
 

#define ALP_TEL_INF_CALL_TYPE_RECEIVED   1
 

#define ALP_TEL_INF_GET_ACCUMULATED_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0006)
 

#define ALP_TEL_INF_GET_CALLS_DURATION_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0001)
 

#define ALP_TEL_INF_GET_CALLS_LIST_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0003)
 

#define ALP_TEL_INF_GET_CURRENT_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0005)
 

#define ALP_TEL_INF_GET_IDENTIFICATION_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0000)
 

#define ALP_TEL_INF_GET_MAX_ACCUMULATED_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0008)
 

#define ALP_TEL_INF_GET_PRICE_PER_UNIT_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x000A)
 

#define ALP_TEL_INF_MESSAGES_COUNT   ((ALP_TEL_INF_SET_PRICE_PER_UNIT_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 

Total count of information service messages.

#define ALP_TEL_INF_PHONE_INFORMATION_MAX_SIZE   128
 

#define ALP_TEL_INF_PHONE_MANUFACTURER   0
 

Phone information type: phone manufacturer.

#define ALP_TEL_INF_PHONE_MODEL   1
 

Phone information type: phone model.

#define ALP_TEL_INF_PHONE_REVISION   2
 

Phone information type: phone revision.

#define ALP_TEL_INF_PHONE_SERIAL_NUMBER   3
 

Phone information type: phone serial number.

#define ALP_TEL_INF_RESET_ACCUMULATED_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0007)
 

#define ALP_TEL_INF_RESET_CALLS_DURATION_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0002)
 

#define ALP_TEL_INF_RESET_CALLS_LIST_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0004)
 

#define ALP_TEL_INF_SET_MAX_ACCUMULATED_CALL_METER_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x0009)
 

#define ALP_TEL_INF_SET_PRICE_PER_UNIT_MESSAGE   ((ALP_TEL_INF_SERVICE_ID << 8) | 0x000B)
 

#define ALP_TEL_INF_SUBSCRIBER_IDENTITY   4
 

Phone information type: subscriber identity.

#define ALP_TEL_IS_INF_GET_ACCUMULATED_CALL_METER_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_ACCUMULATED_CALL_METER_MESSAGE)
 

#define ALP_TEL_IS_INF_GET_CALLS_DURATION_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_CALLS_DURATION_MESSAGE)
 

#define ALP_TEL_IS_INF_GET_CALLS_LIST_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_CALLS_LIST_MESSAGE)
 

#define ALP_TEL_IS_INF_GET_CURRENT_CALL_METER_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_CURRENT_CALL_METER_MESSAGE)
 

#define ALP_TEL_IS_INF_GET_IDENTIFICATION_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_IDENTIFICATION_MESSAGE)
 

#define ALP_TEL_IS_INF_GET_MAX_ACCUMULATED_CALL_METER_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_MAX_ACCUMULATED_CALL_METER_MESSAGE)
 

#define ALP_TEL_IS_INF_GET_PRICE_PER_UNIT_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_GET_PRICE_PER_UNIT_MESSAGE)
 

#define ALP_TEL_IS_INF_RESET_ACCUMULATED_CALL_METER_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_RESET_ACCUMULATED_CALL_METER_MESSAGE)
 

#define ALP_TEL_IS_INF_RESET_CALLS_DURATION_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_RESET_CALLS_DURATION_MESSAGE)
 

#define ALP_TEL_IS_INF_RESET_CALLS_LIST_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_RESET_CALLS_LIST_MESSAGE)
 

#define ALP_TEL_IS_INF_SET_MAX_ACCUMULATED_CALL_METER_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_SET_MAX_ACCUMULATED_CALL_METER_MESSAGE)
 

#define ALP_TEL_IS_INF_SET_PRICE_PER_UNIT_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_INF_SET_PRICE_PER_UNIT_MESSAGE)
 

Typedef Documentation

typedef struct _AlpTelInfCall AlpTelInfCall
 

typedef struct _AlpTelInfCallsDuration AlpTelInfCallsDuration
 

typedef struct _AlpTelInfCallsList AlpTelInfCallsList
 

typedef struct _AlpTelInfIdentification AlpTelInfIdentification
 

typedef struct _AlpTelInfPricePerUnit AlpTelInfPricePerUnit
 

Function Documentation

alp_status_t alp_tel_inf_get_accumulated_call_meter (  AlpTelApplicationId  iAppId,
uint32_t *  oAccumulatedCallMeterP,
AlpTelTransId *  ioTransIdP
) 
 

Return the value of accumulated call meter.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] oAccumulatedCallMeterP The accumulated call meter, in home unit.
[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
Since:
ALP iSDK 1.1

alp_status_t alp_tel_inf_get_calls_duration (  AlpTelApplicationId  iAppId,
AlpTelInfCallsDuration *  ioCallsDurationP,
AlpTelTransId *  ioTransIdP
) 
 

Gets information about the last call duration, the total calls received duration, and the total calls dialed duration.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioCallsDurationP Pointer to a AlpTelInfCallsDuration structure.
[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 calls duration has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_inf_get_calls_list (  AlpTelApplicationId  iAppId,
AlpTelInfCallsList *  ioCallsListP,
AlpTelTransId *  ioTransIdP
) 
 

Gets a list of the specified type of calls (missed, retrieved, or dialed), or the count of calls.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioCallsListP Pointer to a TelInfCallsListType structure. On input, specify the type of calls to receive in the type field. On input, if you set the listP field to NULL and count to 0, then this function returns only the count of calls in count, and errNone. No other call information is returned.
[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 calls list has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_inf_get_current_call_meter (  AlpTelApplicationId  iAppId,
uint32_t *  oCurrentCallMeterP,
AlpTelTransId *  ioTransIdP
) 
 

Get information about the cost of the current call.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] oCurrentCallMeterP The cost of the current call, in home unit.
[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 cost information of the call has been retrieved successfuly.
Since:
ALP iSDK 1.1

alp_status_t alp_tel_inf_get_identification (  AlpTelApplicationId  iAppId,
AlpTelInfIdentification *  ioIdentificationP,
AlpTelTransId *  ioTransIdP
) 
 

Gets phone identification information including manufacturer, model, revision, serial number or the international mobile subscriber identity.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioIdentificationP Pointer to a TelInfIdentificationType structure. On input, the type field must be a valid type (one of the Information Types constants).
[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 identification information has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_inf_get_max_accumulated_call_meter (  AlpTelApplicationId  iAppId,
uint32_t *  oMaxAccumulatedCallMeterP,
AlpTelTransId *  ioTransIdP
) 
 

Get the accumulated call meter maximum value.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] oMaxAccumulatedCallMeterP The accumulated call meter maximum value.
[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
Since:
ALP iSDK 1.1

alp_status_t alp_tel_inf_get_price_per_unit (  AlpTelApplicationId  iAppId,
AlpTelInfPricePerUnit *  oPricePerUnitP,
AlpTelTransId *  ioTransIdP
) 
 

Get the price per unit and the currency.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] oPricePerUnitP 
[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
Since:
ALP iSDK 1.1

alp_status_t alp_tel_inf_reset_accumulated_call_meter (  AlpTelApplicationId  iAppId,
AlpTelTransId *  ioTransIdP
) 
 

Reset the value of accumulated call meter.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[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
Since:
ALP iSDK 1.1

alp_status_t alp_tel_inf_reset_calls_duration (  AlpTelApplicationId  iAppId,
AlpTelTransId *  ioTransIdP
) 
 

Resets all call duration timers.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[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 calls duration has been reset successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_inf_reset_calls_list (  AlpTelApplicationId  iAppId,
uint8_t  iCallType,
AlpTelTransId *  ioTransIdP
) 
 

Empty the calls list.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iCallType Type of calls list to reset. Specify one of the Call Types constants.
[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 calls list has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_inf_set_max_accumulated_call_meter (  AlpTelApplicationId  iAppId,
uint32_t  iMaxAccumulatedCallMeter,
AlpTelTransId *  ioTransIdP
) 
 

Set the accumulated call meter maximum value.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iMaxAccumulatedCallMeter The accumulated call meter maximum value to set.
[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
Since:
ALP iSDK 1.1

alp_status_t alp_tel_inf_set_price_per_unit (  AlpTelApplicationId  iAppId,
AlpTelInfPricePerUnit *  iPricePerUnitP,
AlpTelTransId *  ioTransIdP
) 
 

Set the price per unit and the currency.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iPricePerUnitP 
[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
Since:
ALP iSDK 2.1

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.