Phonebook Service
[Mobile Services]

Detailed Description

This service groups the Phonebook functions.

Define Documentation

#define ALP_MBL_PHB_NOTIFICATION_CONTACTS_LIST_EXPORTED ((AlpMblNotificationId) 2)

Contacts list has been successfully exported to the SIM card.

#define ALP_MBL_PHB_NOTIFICATION_SIM_CARD_PHONEBOOK_IMPORTED ((AlpMblNotificationId) 1)

SIM entries have been imported to the contacts_dml data base.

#define ALP_MBL_PHB_NOTIFICATION_SIM_CONTACTS_INSERTED ((AlpMblNotificationId) 3)

SIM contacts have been inserted in the contacts_dml data base.

#define ALP_MBL_PHONEBOOK_EMERGENCY ((AlpMblPhonebookId) 6)

SIM or ME emergency number list.

#define ALP_MBL_PHONEBOOK_OWN_NUMBERS ((AlpMblPhonebookId) 5)

SIM or ME own numbers list.

#define ALP_MBL_PHONEBOOK_SIM ((AlpMblPhonebookId) 1)

SIM phonebook (2G Phonebook).

#define ALP_MBL_PHONEBOOK_SIM_FIX_DIALLING ((AlpMblPhonebookId) 4)

SIM fixdialling phonebook.

#define ALP_MBL_PHONEBOOK_SIM_SERVICE ((AlpMblPhonebookId) 3)

SIM service number.

#define ALP_MBL_PHONEBOOK_USIM ((AlpMblPhonebookId) 2)

USIM Phonebook (3G Phonebook).

Typedef Documentation

typedef struct _AlpMblContactList AlpMblContactList

typedef void(* AlpMblPhbContactsListExportedCallbackPtr)(void *iUserDataP, AlpMblPhonebookId iPhoneBookId, uint16_t iAvailableSlots, AlpMblContactList *iSimContactsListP)

Callback prototype for ALP_MBL_PHB_NOTIFICATION_CONTACTS_LIST_EXPORTED notification.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iSimContactsListP - list of the new SIM contacts inserted in the contacts_dml data base.

[in] iPhoneBookId - Id of the SIM phonebook where the contacts have been exported.

[in] iAvailableSlots - number of remaining empty slots in the SIM phonebook.

typedef void(* AlpMblPhbSimCardPhonebookImportedCallbackPtr)(void *iUserDataP, AlpMblPhonebookId iPhoneBookId, uint16_t iAvailableSlots)

Callback prototype for ALP_MBL_PHB_NOTIFICATION_SIM_CARD_PHONEBOOK_IMPORTED notification.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iPhoneBookId - Id of the SIM phonebook imported to phone local contacts.

[in] iAvailableSlots - number of remaining empty slots in the SIM phonebook.

typedef void(* AlpMblPhbSimContactsInsertedCallbackPtr)(void *iUserDataP, AlpMblPhonebookId iPhoneBookId, uint16_t iAvailableSlots)

Callback prototype for ALP_MBL_PHB_NOTIFICATION_SIM_CONTACTS_INSERTED notification.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iPhoneBookId - Id of the SIM phonebook imported to phone local contacts.

[in] iAvailableSlots - number of remaining empty slots in the SIM phonebook.

typedef struct _AlpMblPhonebook AlpMblPhonebook

typedef uint8_t AlpMblPhonebookId

typedef struct _AlpMblPhonebookList AlpMblPhonebookList

Function Documentation

alp_status_t alp_mbl_phonebook_add_sim_entry ( AlpLuid iContactLuid,

AlpLuid * oSimContactP,

AlpMblPhonebookId iPhonebookId

)

To export a contact to the SIM Phonebook and insert a new SIM contact in the contacts_dml data base.

Parameters:

[in] iContactLuid - Contact to add.

[out] oSimContactP - Pointer to the new SIM Contact Luid inserted in the contacts_dml data base.

[in] iPhonebookId - Identifier of the phonebook where to export the contact.

Returns:
ALP_STATUS_OK - A new SIM entry is stored in the SIM Phonebook and a new SIM contact is inserted in the contacts_dml data base.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

Note:
Note that DML error codes can also be returned.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_phonebook_delete_sim_entry ( AlpLuid iContactLuid )

Delete a contact from the SIM card Phonebook and from the contacts_dml database.

Parameters:

[in] iContactLuid - Contact to remove.

Returns:
ALP_STATUS_OK - The corresponding SIM entry is deleted from the SIM phonebook and the contact is deleted from the contacts_dml data base.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

Note:
Note that DML error codes can also be returned.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_phonebook_export_contacts_to_sim ( AlpMblContactList * iContactListP,

AlpMblPhonebookId iPhonebookId

)

To export a list of contacts to the SIM Phonebook and insert new SIM contacts in the contact_dml data base. Before the export operation, the existing SIM contacts are deleted and the SIM storage is flushed

Parameters:

[in] iContactListP - Pointer to a list of contacts to be exported.

[in] iPhonebookId - Identifier of the phonebook where to export the contacts.

Returns:
ALP_STATUS_OK - The list of contacts is being added.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

Note:
Note that DML error codes can also be returned.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_phonebook_get_phonebook ( AlpMblPhonebookId iPhonebookId,

AlpMblPhonebook * oPhonebookP

)

To get details concerning a phonebook present in the sim card.

Parameters:

[in] iPhonebookId - a phonebook ID

[out] oPhonebookP - pointer to a phonebook structure

Returns:
ALP_STATUS_OK - The phonebook properties have been retrieved successfully.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.
ALP_STATUS_MBL_NO_SIM_CARD_INSERTED - No SIM card is inserted
ALP_STATUS_MBL_INVALID_OBJECT - this phonebook is not imported by mobiled, so you need first to import this phonebook (use 'alp_mbl_phonebook_import_all_sim_entries') before requesting again its properties.
ALP_STATUS_MBL_INVALID_PARAMETER - oPhonebooksP is NULL or the phonebook Id is not valid.

alp_status_t alp_mbl_phonebook_get_phonebooks ( AlpMblPhonebookList * oPhonebooksP )

To get the list of phonebooks available in the sim card.

Parameters:

[out] oPhonebooksP - Pointer to an AlpMblPhonebookList, to store the list of available phonebooks.

Returns:
ALP_STATUS_OK - The available phonebooks have been retrieved successfully.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.
ALP_STATUS_MBL_NO_SIM_CARD_INSERTED - No SIM card is inserted
ALP_STATUS_MBL_VALUE_NOT_AVAILABLE - The phonebook list is not yet available.
ALP_STATUS_MBL_INVALID_PARAMETER - oPhonebooksP is NULL or the phonebook Id is not valid.

alp_status_t alp_mbl_phonebook_import_all_sim_entries ( AlpMblPhonebookId iPhonebookId )

To import all SIM entries from the specified phonebook to the contacts_dml data base.

Parameters:

[in] iPhonebookId - Identifier of the phonebook to be imported.

Returns:
ALP_STATUS_OK - The operation is under progress.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

Note:
Note that DML error codes can also be returned.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_phonebook_update_sim_entry ( AlpLuid iContactLuid )

Update a SIM entry in the SIM card Phonebook according the change(s) done in the contact.

Parameters:

[in] iContactLuid - Contact to update.

Returns:
ALP_STATUS_OK - The SIM entry is updated according the change(s) done in the contact.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

Note:
Note that DML error codes can also be returned.

Since:
ALP iSDK 1.0

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


Data Structures
struct	_AlpMblContactList
struct	_AlpMblPhonebook
struct	_AlpMblPhonebookList
Defines
#define	ALP_MBL_PHB_NOTIFICATION_CONTACTS_LIST_EXPORTED ((AlpMblNotificationId) 2)
	Contacts list has been successfully exported to the SIM card.
#define	ALP_MBL_PHB_NOTIFICATION_SIM_CARD_PHONEBOOK_IMPORTED ((AlpMblNotificationId) 1)
	SIM entries have been imported to the contacts_dml data base.
#define	ALP_MBL_PHB_NOTIFICATION_SIM_CONTACTS_INSERTED ((AlpMblNotificationId) 3)
	SIM contacts have been inserted in the contacts_dml data base.
#define	ALP_MBL_PHONEBOOK_EMERGENCY ((AlpMblPhonebookId) 6)
	SIM or ME emergency number list.
#define	ALP_MBL_PHONEBOOK_OWN_NUMBERS ((AlpMblPhonebookId) 5)
	SIM or ME own numbers list.
#define	ALP_MBL_PHONEBOOK_SIM ((AlpMblPhonebookId) 1)
	SIM phonebook (2G Phonebook).
#define	ALP_MBL_PHONEBOOK_SIM_FIX_DIALLING ((AlpMblPhonebookId) 4)
	SIM fixdialling phonebook.
#define	ALP_MBL_PHONEBOOK_SIM_SERVICE ((AlpMblPhonebookId) 3)
	SIM service number.
#define	ALP_MBL_PHONEBOOK_USIM ((AlpMblPhonebookId) 2)
	USIM Phonebook (3G Phonebook).
Typedefs
typedef _AlpMblContactList	AlpMblContactList
typedef void(*	AlpMblPhbContactsListExportedCallbackPtr )(void iUserDataP, AlpMblPhonebookId iPhoneBookId, uint16_t iAvailableSlots, AlpMblContactList iSimContactsListP)
typedef void(*	AlpMblPhbSimCardPhonebookImportedCallbackPtr )(void *iUserDataP, AlpMblPhonebookId iPhoneBookId, uint16_t iAvailableSlots)
typedef void(*	AlpMblPhbSimContactsInsertedCallbackPtr )(void *iUserDataP, AlpMblPhonebookId iPhoneBookId, uint16_t iAvailableSlots)
typedef _AlpMblPhonebook	AlpMblPhonebook
typedef uint8_t	AlpMblPhonebookId
typedef _AlpMblPhonebookList	AlpMblPhonebookList
Functions
alp_status_t	alp_mbl_phonebook_add_sim_entry (AlpLuid iContactLuid, AlpLuid *oSimContactP, AlpMblPhonebookId iPhonebookId)
alp_status_t	alp_mbl_phonebook_delete_sim_entry (AlpLuid iContactLuid)
alp_status_t	alp_mbl_phonebook_export_contacts_to_sim (AlpMblContactList *iContactListP, AlpMblPhonebookId iPhonebookId)
alp_status_t	alp_mbl_phonebook_get_phonebook (AlpMblPhonebookId iPhonebookId, AlpMblPhonebook *oPhonebookP)
alp_status_t	alp_mbl_phonebook_get_phonebooks (AlpMblPhonebookList *oPhonebooksP)
alp_status_t	alp_mbl_phonebook_import_all_sim_entries (AlpMblPhonebookId iPhonebookId)
alp_status_t	alp_mbl_phonebook_update_sim_entry (AlpLuid iContactLuid)

Phonebook Service [Mobile Services]

Detailed Description

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation

Phonebook Service
[Mobile Services]