Phonebook Service
[Telephony Mgr]

Detailed Description

This service groups the Telephony phonebook functions.


Data Structures

struct  _AlpTelPhbEntries
struct  _AlpTelPhbEntry
struct  _AlpTelPhbPhonebook
struct  _AlpTelPhbPhonebooks

Defines

#define ALP_TEL_IS_PHB_ACCESS_READY_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_ACCESS_READY_MESSAGE)
#define ALP_TEL_IS_PHB_ADD_ENTRY_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_ADD_ENTRY_MESSAGE)
#define ALP_TEL_IS_PHB_DELETE_ENTRY_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_DELETE_ENTRY_MESSAGE)
#define ALP_TEL_IS_PHB_GET_ENTRIES_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_GET_ENTRIES_MESSAGE)
#define ALP_TEL_IS_PHB_GET_ENTRY_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_GET_ENTRY_MESSAGE)
#define ALP_TEL_IS_PHB_GET_PHONEBOOK_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_GET_PHONEBOOK_MESSAGE)
#define ALP_TEL_IS_PHB_GET_PHONEBOOKS_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_GET_PHONEBOOKS_MESSAGE)
#define ALP_TEL_IS_PHB_SET_PHONEBOOK_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_SET_PHONEBOOK_MESSAGE)
#define ALP_TEL_PHB_ACCESS_READY_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0007)
#define ALP_TEL_PHB_ADD_ENTRY_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0005)
#define ALP_TEL_PHB_AP   0x4150
 AP: Application Phonebook.
#define ALP_TEL_PHB_CONTACT_TYPE_FAX   4
 contact type Fax
#define ALP_TEL_PHB_CONTACT_TYPE_HOME   1
 contact type Home
#define ALP_TEL_PHB_CONTACT_TYPE_MOBILE   3
 contact type Mobile
#define ALP_TEL_PHB_CONTACT_TYPE_OTHER   6
 contact type Other
#define ALP_TEL_PHB_CONTACT_TYPE_VIDEO   5
 contact type Video
#define ALP_TEL_PHB_CONTACT_TYPE_WORK   2
 contact type Work
#define ALP_TEL_PHB_DELETE_ENTRY_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0006)
#define ALP_TEL_PHB_EMERGENCY   0x454E
 EN: SIM or ME emergency number list.
#define ALP_TEL_PHB_GET_ENTRIES_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0003)
#define ALP_TEL_PHB_GET_ENTRY_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0004)
#define ALP_TEL_PHB_GET_PHONEBOOK_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0001)
#define ALP_TEL_PHB_GET_PHONEBOOKS_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0000)
#define ALP_TEL_PHB_MAX_ADDITIONAL_NUMBER_COUNT   4
#define ALP_TEL_PHB_MAX_EMAIL_ADDRESS_COUNT   4
#define ALP_TEL_PHB_MAX_PHONEBOOKS_NUMBER   32
#define ALP_TEL_PHB_ME   0x4D45
 ME: ME phonebook.
#define ALP_TEL_PHB_ME_AND_SIM   0x4D54
 MT: Combined ME and SIM phonebook.
#define ALP_TEL_PHB_ME_DIALLED   0x4443
 DC: Mobile Equipment (ME) dialled calls list.
#define ALP_TEL_PHB_ME_MISSED   0x4D43
 MC: ME missed calls list.
#define ALP_TEL_PHB_ME_RECEIVED   0x5243
 RC: ME received calls list.
#define ALP_TEL_PHB_MESSAGES_COUNT   ((ALP_TEL_PHB_ACCESS_READY_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 Total count of phonebook service messages.
#define ALP_TEL_PHB_OWN_NUMBERS   0x4F4E
 ON: SIM or ME own numbers list.
#define ALP_TEL_PHB_SD   0x5344
 SD: SIM service number.
#define ALP_TEL_PHB_SET_PHONEBOOK_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0002)
#define ALP_TEL_PHB_SIM   0x534D
 SM: SIM phonebook.
#define ALP_TEL_PHB_SIM_FIX_DIALLING   0x4644
 FD: SIM fixdialling phonebook.
#define ALP_TEL_PHB_SIM_LAST_DIALLING   0x4C44
 LD: SIM last dialling phonebook.
#define ALP_TEL_PHB_TA   0x5441
 TA: Terminal Adaptor (TA) phonebook.

Typedefs

typedef _AlpTelPhbEntries AlpTelPhbEntries
typedef _AlpTelPhbEntry AlpTelPhbEntry
typedef _AlpTelPhbPhonebook AlpTelPhbPhonebook
typedef _AlpTelPhbPhonebooks AlpTelPhbPhonebooks

Functions

alp_status_t alp_tel_phb_access_ready (AlpTelApplicationId iAppId, bool *oAccessReadyP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_phb_add_entry (AlpTelApplicationId iAppId, AlpTelPhbEntry *iEntryP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_phb_delete_entry (AlpTelApplicationId iAppId, uint16_t iEntryIndex, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_phb_get_entries (AlpTelApplicationId iAppId, AlpTelPhbEntries *ioEntriesP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_phb_get_entry (AlpTelApplicationId iAppId, AlpTelPhbEntry *ioEntryP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_phb_get_phonebook (AlpTelApplicationId iAppId, AlpTelPhbPhonebook *oPhonebookP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_phb_get_phonebooks (AlpTelApplicationId iAppId, AlpTelPhbPhonebooks *ioPhonebooksP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_phb_set_phonebook (AlpTelApplicationId iAppId, AlpTelPhbPhonebook *ioPhonebookP, AlpTelTransId *ioTransIdP)

Define Documentation

#define ALP_TEL_IS_PHB_ACCESS_READY_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_ACCESS_READY_MESSAGE)
 

#define ALP_TEL_IS_PHB_ADD_ENTRY_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_ADD_ENTRY_MESSAGE)
 

#define ALP_TEL_IS_PHB_DELETE_ENTRY_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_DELETE_ENTRY_MESSAGE)
 

#define ALP_TEL_IS_PHB_GET_ENTRIES_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_GET_ENTRIES_MESSAGE)
 

#define ALP_TEL_IS_PHB_GET_ENTRY_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_GET_ENTRY_MESSAGE)
 

#define ALP_TEL_IS_PHB_GET_PHONEBOOK_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_GET_PHONEBOOK_MESSAGE)
 

#define ALP_TEL_IS_PHB_GET_PHONEBOOKS_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_GET_PHONEBOOKS_MESSAGE)
 

#define ALP_TEL_IS_PHB_SET_PHONEBOOK_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_PHB_SET_PHONEBOOK_MESSAGE)
 

#define ALP_TEL_PHB_ACCESS_READY_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0007)
 

#define ALP_TEL_PHB_ADD_ENTRY_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0005)
 

#define ALP_TEL_PHB_AP   0x4150
 

AP: Application Phonebook.

#define ALP_TEL_PHB_CONTACT_TYPE_FAX   4
 

contact type Fax

#define ALP_TEL_PHB_CONTACT_TYPE_HOME   1
 

contact type Home

#define ALP_TEL_PHB_CONTACT_TYPE_MOBILE   3
 

contact type Mobile

#define ALP_TEL_PHB_CONTACT_TYPE_OTHER   6
 

contact type Other

#define ALP_TEL_PHB_CONTACT_TYPE_VIDEO   5
 

contact type Video

#define ALP_TEL_PHB_CONTACT_TYPE_WORK   2
 

contact type Work

#define ALP_TEL_PHB_DELETE_ENTRY_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0006)
 

#define ALP_TEL_PHB_EMERGENCY   0x454E
 

EN: SIM or ME emergency number list.

#define ALP_TEL_PHB_GET_ENTRIES_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0003)
 

#define ALP_TEL_PHB_GET_ENTRY_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0004)
 

#define ALP_TEL_PHB_GET_PHONEBOOK_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0001)
 

#define ALP_TEL_PHB_GET_PHONEBOOKS_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0000)
 

#define ALP_TEL_PHB_MAX_ADDITIONAL_NUMBER_COUNT   4
 

#define ALP_TEL_PHB_MAX_EMAIL_ADDRESS_COUNT   4
 

#define ALP_TEL_PHB_MAX_PHONEBOOKS_NUMBER   32
 

#define ALP_TEL_PHB_ME   0x4D45
 

ME: ME phonebook.

#define ALP_TEL_PHB_ME_AND_SIM   0x4D54
 

MT: Combined ME and SIM phonebook.

#define ALP_TEL_PHB_ME_DIALLED   0x4443
 

DC: Mobile Equipment (ME) dialled calls list.

#define ALP_TEL_PHB_ME_MISSED   0x4D43
 

MC: ME missed calls list.

#define ALP_TEL_PHB_ME_RECEIVED   0x5243
 

RC: ME received calls list.

#define ALP_TEL_PHB_MESSAGES_COUNT   ((ALP_TEL_PHB_ACCESS_READY_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 

Total count of phonebook service messages.

#define ALP_TEL_PHB_OWN_NUMBERS   0x4F4E
 

ON: SIM or ME own numbers list.

#define ALP_TEL_PHB_SD   0x5344
 

SD: SIM service number.

#define ALP_TEL_PHB_SET_PHONEBOOK_MESSAGE   ((ALP_TEL_PHB_SERVICE_ID << 8) | 0x0002)
 

#define ALP_TEL_PHB_SIM   0x534D
 

SM: SIM phonebook.

#define ALP_TEL_PHB_SIM_FIX_DIALLING   0x4644
 

FD: SIM fixdialling phonebook.

#define ALP_TEL_PHB_SIM_LAST_DIALLING   0x4C44
 

LD: SIM last dialling phonebook.

#define ALP_TEL_PHB_TA   0x5441
 

TA: Terminal Adaptor (TA) phonebook.

Typedef Documentation

typedef struct _AlpTelPhbEntries AlpTelPhbEntries
 

typedef struct _AlpTelPhbEntry AlpTelPhbEntry
 

typedef struct _AlpTelPhbPhonebook AlpTelPhbPhonebook
 

typedef struct _AlpTelPhbPhonebooks AlpTelPhbPhonebooks
 

Function Documentation

alp_status_t alp_tel_phb_access_ready (  AlpTelApplicationId  iAppId,
bool *  oAccessReadyP,
AlpTelTransId *  ioTransIdP
) 
 

Retrieves the access status of the phonebook

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] oAccessReadyP Pointer to a bool. If true, the phone book storage could be accessed.
[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 phonebook access has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_phb_add_entry (  AlpTelApplicationId  iAppId,
AlpTelPhbEntry *  iEntryP,
AlpTelTransId *  ioTransIdP
) 
 

Adds an entry to the current phone book.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iEntryP Pointer to a AlpTelPhbEntry structure. This index is relative to the phonebook, and must be a value between phonebook first index and phonebook last index. If 'phoneIndex' is set to -1, the entry will be add at the first empty slot.
[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 entry has been add successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_phb_delete_entry (  AlpTelApplicationId  iAppId,
uint16_t  iEntryIndex,
AlpTelTransId *  ioTransIdP
) 
 

Deletes an entry in the current phone book.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iEntryIndex Index of the entry to delete. This index is relative to the phonebook, and must be a value between phonebook first index and phonebook last index.
[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 entry has been delete successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_phb_get_entries (  AlpTelApplicationId  iAppId,
AlpTelPhbEntries *  ioEntriesP,
AlpTelTransId *  ioTransIdP
) 
 

Gets entries from the current phone book between two indexes, and the count of entries retrieved.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioEntriesP Pointer to a AlpTelPhbEntries structure. The 'firstIndex' and 'lastIndex' fields specify the range of phone book entries to return. These index are relative to the phonebook, and must be between phonebook first index and phonebook last index. If the 'entryP' field is NULL, this function returns in the 'entryCount' field the count of entries found between the indexes specified by the 'firstIndex' and 'lastIndex' fields; and no actual entries are 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 entries has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_phb_get_entry (  AlpTelApplicationId  iAppId,
AlpTelPhbEntry *  ioEntryP,
AlpTelTransId *  ioTransIdP
) 
 

Gets an entry from the current phone book.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioEntryP Pointer to a AlpTelPhbEntry structure. On input, the 'phoneIndex' field specifies the entry to return. This index is relative to the phonebook, and must be a value between phonebook first index and phonebook last index.
[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 entry has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_phb_get_phonebook (  AlpTelApplicationId  iAppId,
AlpTelPhbPhonebook *  oPhonebookP,
AlpTelTransId *  ioTransIdP
) 
 

Gets information about the current phone book.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] oPhonebookP Pointer to a AlpTelPhbPhonebook structure that returns information about the current phone book such as its identifier, first index, last index, maximum name size, maximum dial number size, total entry slots, and used entry slots.
[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 phone book information has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_phb_get_phonebooks (  AlpTelApplicationId  iAppId,
AlpTelPhbPhonebooks *  ioPhonebooksP,
AlpTelTransId *  ioTransIdP
) 
 

Gets the list of available phone books, or the count of them.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioPhonebooksP Pointer to a AlpTelPhbPhonebooks structure. On input, the 'count' field must be the count of elements in the 'idP' buffer. If you set the 'idP' field to NULL, this function returns in the 'count' field the number of available phone books.
[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 list of available phone books has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_phb_set_phonebook (  AlpTelApplicationId  iAppId,
AlpTelPhbPhonebook *  ioPhonebookP,
AlpTelTransId *  ioTransIdP
) 
 

Sets the current phone book.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioPhonebookP Identifier of the phone book to set as the current one. One of the constants ALP_TEL_PHB_XXX.
[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 phone book has been set successfuly.
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.