From d4123751263faad62003c01ac58298110fe1a4ca Mon Sep 17 00:00:00 2001 From: Jeesun Kim Date: Mon, 19 Dec 2016 20:22:06 +0900 Subject: [PATCH] 3.0 Native API reference english examination Change-Id: I80d6ff61ca687708773679115e63bfc68b425a74 --- doc/contacts_doc.h | 360 ++++++------- include/contacts.h | 4 + include/contacts_activity.h | 72 ++- include/contacts_db.h | 1176 ++++++++++++++++++------------------------ include/contacts_db_status.h | 96 ++-- include/contacts_errors.h | 37 +- include/contacts_filter.h | 245 ++++----- include/contacts_group.h | 102 ++-- include/contacts_list.h | 202 +++----- include/contacts_person.h | 277 +++++----- include/contacts_phone_log.h | 86 ++- include/contacts_query.h | 134 ++--- include/contacts_record.h | 442 +++++++--------- include/contacts_service.h | 125 ++--- include/contacts_setting.h | 248 ++++----- include/contacts_types.h | 312 ++++++----- include/contacts_vcard.h | 210 ++++---- include/contacts_views.h | 635 ++++++++++++----------- 18 files changed, 2124 insertions(+), 2639 deletions(-) diff --git a/doc/contacts_doc.h b/doc/contacts_doc.h index 86addfc..fe4cfc1 100644 --- a/doc/contacts_doc.h +++ b/doc/contacts_doc.h @@ -17,6 +17,7 @@ * */ + #ifndef __TIZEN_SOCIAL_CONTACTS_DOC_H__ #define __TIZEN_SOCIAL_CONTACTS_DOC_H__ @@ -24,139 +25,123 @@ /** * @ingroup CAPI_SOCIAL_FRAMEWORK * @defgroup CAPI_SOCIAL_CONTACTS_SVC_MODULE Contacts - * * @brief The Contacts Service API provides methods for managing contact information for people. - * A contact object is always associated with a specific address book. - * A person object is an aggregation of one or more contacts associated with the same person. - * - * - * + * A contact object is always associated with a specific address book. + * A person object is an aggregation of one or more contacts associated with the same person. * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_HEADER Required Header - * \#include - * - * + * \#include * * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_OVERVIEW Overview * The Contacts-service provides functions for managing contact information for people. * A contact object is always associated with a specific address book. * A person object is an aggregation of one or more contacts associated with the same person. - * * Contacts-service has a relationship between Entities. - * @image html Contact_structure.png "Figure: Contact structure" * + * @image html Contact_structure.png "Figure: Contact structure" * There are three same contacts made from different address book. * Person1 is an aggregation of Contact1, Contact2 and Contact3. - * * The contacts-service provides an interface to manage the information * * * * *
* - Managing contacts information stored in database
* - Aggregating contacts information from various accounts
- * - Notifying changes of contacts information
+ * - Notifying changes of contacs information
* - Searching contacts information
* - vCard supports
*
* - * - * * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_ENTITIES Entities * Contacts-Service manages information related to following entities. * - Contact * - Information for individuals, like name, phone number, email, address, job, instant messenger, company, etc. * - Account - * - Accounts are handled by account module. Contacts-service should use account ID which is created the module + * - Accounts are handled by account module. Contacts-service should use account ID which is created in the module. * - Exceptionally, Local device address book has no account and its related account ID is zero. * - Each account can create only one address book. * - Address book * - Represents where contacts and groups should belong to * - Created by one of contacts sources below - * - Local device, which has no account - * - Service providers such as Google or Yahoo, with account + * - Local device, which has no account. + * - Service providers such as Google or Yahoo, with account. * - Applications like ChatON, Joyn, Facebook, etc. * - Group - * - Grouped contacts on a same address book - * - Groups and contacts have many-to-many relationship + * - Grouped contacts on a same address book. + * - Groups and contacts have many-to-many relationship. * - Person - * - A virtual contact that keeps merged information of contacts linked together + * - A virtual contact that keeps merged information of contacts linked together. * - When more than one contact from different sources designate same individual, then instead of showing each contacts separately, by Person concept, they can be shown and managed as one virtual contact. - * - Every contact becomes to be linked to at least one person. + * - Every contact becomes linked to at least one person. * - My profile * - My information which has almost same properties as contact information but it has no properties such as group relation, ringtone and message alert. - * - Single entry can be available on each address book + * - Single entry can be available on each address book. * - Activity * - Social activities are stored. * - Speed Dial - * - Shortcut dialing number key information + * - Shortcut dialing number key information. * - Phone Log - * - Call or message logs are stored - * + * - Call or message logs are stored. * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_ENTITIES_RELATIONSHIP Relationship between entities * Contacts-service has a relationship between Entities. - * @image html Relationship_between_entities.png "Figure: Relationship between entities" * + * @image html Relationship_between_entities.png "Figure: Relationship between entities" * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_RELATIONSHIP_BETWEEN_CONTACT_AND_PERSON Relationship between Contact and Person * Person will be created automatically when inserting a contact record. Cannot create person record directly. * * Sample code: Insert a contact record - * * @code - * // create contact record + * // Create contact record * contacts_record_h contact = NULL; * contacts_record_create(_contacts_contact._uri, &contact); * - * // add name + * // Add name * contacts_record_h name = NULL; * contacts_record_create(_contacts_name._uri, &name); * contacts_record_set_str(name, _contacts_name.first, “test”); * contacts_record_add_child_record(contact, _contacts_contact.name, name); * - * // add number + * // Add number * contacts_record_h number = NULL; * contacts_record_create(_contacts_number._uri, &number); * contacts_record_set_str(number, _contacts_number.number, “1234”); * contacts_record_add_child_record(contact, _contacts_contact.number, number); * - * // insert to database + * // Insert to database * int contact_id = 0; * contacts_db_insert_record(contact, &contact_id); * - * // destroy record + * // Destroy record * contacts_record_destroy(contact, true); * @endcode * * @image html Creating_a_person_record.png "Figure: Creating a person record" - * * Person record can be link to another person. Even though contacts address book is different, link is possible. * * Sample code: Link contact * @code - * int person_id1 = ... // acquire ID of Person1 record - * int person_id2 = ... // acquire ID of Person2 record + * int person_id1 = ... // Acquire ID of Person1 record + * int person_id2 = ... // Acquire ID of Person2 record * * contacts_person_link_person(person_id1, person_id2); * @endcode * * @image html Link_person.png "Figure: Link person" - * * Contact record can be separate from person record. New person will be created when unlinking contact record. * * Sample code: Unlink contact * @code - * int person_id1 = ... // acquire ID of Person1 record - * int contact_id3 = ... // acquire ID of Contact3 record + * int person_id1 = ... // Acquire ID of Person1 record + * int contact_id3 = ... // Acquire ID of Contact3 record * * contacts_person_unlink_contact(person_id1, contact_id3); * @endcode * * @image html Unlink_contact.png "Figure: Unlink contact" * - * - * * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_VIEWS Views * To access and handle entities, views are provided. * According to data-view declarations, generic access functions are used (contacts_db_insert_record(), contacts_record_get_int(), …). @@ -165,7 +150,6 @@ * A data-view is a structure, which has property elements. * For example, the _contacts_contact view describes the properties of the contact record. * Its properties include name, company, nickname of the contact and many more. - * * * * @@ -177,7 +161,7 @@ * * * - * + * * * * @@ -192,48 +176,46 @@ * * * - * + * * * * * * *
Table: Contact editable views
_contacts_person Describes the properties of the person
_contacts_simple_contact Describes the properties of the contact
_contacts_contact Describes the properties of the contact
_contacts_my_profile Describes the properties of the my profile
_contacts_my_profile Describes the properties of my profile
_contacts_name Describes the properties of the contacts name
_contacts_number Describes the properties of the contacts number
_contacts_email Describes the properties of the contacts email
_contacts_nickname Describes the properties of the contacts nickname
_contacts_messenger Describes the properties of the contacts messenger
_contacts_extension Describes the properties of the extension
_contacts_sdn Describes the properties of the service describe number
_contacts_sdn Describes the properties of the service description number
_contacts_profile Describes the properties of the profile
_contacts_activity_photo Describes the properties of the photo of contacts activity
_contacts_activity Describes the properties of the contacts activity
_contacts_speeddial Describes the properties of the speed dial
_contacts_phone_log Describes the properties of the log
- * * * * * * * - * - * - * - * - * + * + * + * + * + * * * * * - * - * + * + * * - * + * * * * * - * + * *
Table: Contact read only views
View (Read only)Description
_contacts_contact_updated_info used when identifying contact changes depending on version.
_contacts_my_profile_updated_info used when identifying my profile changes depending on version.
_contacts_group_updated_info used when identifying group changes depending on version.
_contacts_group_member_updated_info used when identifying group member changes depending on version.
_contacts_grouprel_updated_info used when identifying group relation profile changes depending on version.
_contacts_contact_updated_info used when identifying contact changes depending on version
_contacts_my_profile_updated_info used when identifying my profile changes depending on version
_contacts_group_updated_info used when identifying group changes depending on version
_contacts_group_member_updated_info used when identifying group member changes depending on version
_contacts_grouprel_updated_info used when identifying group relation profile changes depending on version
_contacts_person_contact used when querying to merge information of person and contact
_contacts_person_number used when querying to merge information of person and number
_contacts_person_email used when querying to merge information of person and email
_contacts_person_grouprel used when querying to merge information of person and group relation
_contacts_person_group_assigned used when querying to information of person who assigned group
_contacts_person_group_not_assigned used when querying to information of person who not assigned group
_contacts_person_group_assigned used when querying for information of person who is assigned to group
_contacts_person_group_not_assigned used when querying for information of person who is not assigned to group
_contacts_person_phone_log used when querying to merge information of person and phone log
_contacts_person_usage used when querying to information of person usage
_contacts_person_usage used when querying for information of person usage
_contacts_contact_number used when querying to merge information of contact and number
_contacts_contact_email used when querying to merge information of contact and email
_contacts_contact_grouprel used when querying to merge information of contact and group relation
_contacts_contact_activity used when querying to merge information of contact and activity
_contacts_phone_log_stat used when querying to information of phone log status
_contacts_phone_log_stat used when querying for information of phone log status
* - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_VIEWS_PROPERTIES Properties * Property elements have their data types and name.
* Record types which have *_id as their properties, hold identifiers of other records - e.g. name, number and email views hold ID of their corresponding contacts in contact_id property (as children of the corresponding contacts record).
* A type of some property is ‘record’. * It means that the parent record can have child records. * For example, a contact record has 'name', 'number' and 'email' properties, which means that records of those types can be children of contact type records.
- * In contacts_view.h headear file, view macros are found and below figure shows what macro means. + * In contacts_view.h headear file, view macros are found and below figure shows what the macro means. * * @image html Properties.png "Figure: Properties" * @@ -242,7 +224,7 @@ * contacts_record_h contact = NULL; * contacts_record_create(_contacts_contact._uri, &contact); * - * // set image to _contacts_contact view. + * // Set image to _contacts_contact view * contacts_record_h image = NULL; * contacts_record_create(_contacts_image._uri, &image); * @@ -252,35 +234,35 @@ * free(resource_path); * contacts_record_set_str(image, _contacts_image.path, caller_id_path); * - * // add image record to contact + * // Add image record to contact * contacts_record_add_child_record(contact, _contacts_contact.image, image); * @endcode * * - * - * - * - * - * + * + * + * + * + * - * + * + * + * *
Note
For an application to insert private images in contacts, it needs to follow below conditions:
+ *
Note
For an application to insert private images in contacts, it needs to follow below conditions:
*    1. Application must have privilege of http://tizen.org/privilege/contact.write to use APIs such as contacts_db_insert_record().
*    2. Application's private directory and files must have 'read' permission of others, '644' for example. SMACK protects read permission from the other applications.
*    3. Application may erase the image after destroying the contact record (contacts_record_destroy).
- *
- * * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_RECORDS Records - * In contacts-service, one of basic concept is a record. + * In contacts-service, one of the basic concept is a record. * It may be helpful to know that a record represents an actual record in the internal database, but in general, * you can think of a record as a piece of information, like an address, phone number or group of contacts. * A record can be a complex set of data, containing other data, e.g. an address record contains country, region, and street, among others.
* Also, the contained data can be a reference to another record. * For example, a contact record contains the 'address' property, which is a reference to an address record. * An address record belongs to a contact record - its 'contact_id' property is set to identifier of the corresponding contact (more on IDs later). - * In this case, the address is the contact's child record and the contact is the parent record.
+ * In this case, the address is the contacts child record and the contact is the parent record.
* Effectively, a record can be a node in a tree or graph of relations between records. * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_RECORDS_URI URI * Each record type has a special structure defined for it, called 'view', which contains identifiers of its properties.
* Every view has a special field - _uri - that uniquely identifies the view. @@ -288,22 +270,21 @@ * * APIs which needs _uri * @code - * API int contacts_record_create(const char* view_uri, ...) - * API int contacts_filter_create(const char* view_uri, ...) - * API int contacts_query_create(const char* view_uri, ...) - * API int contacts_db_get_record(const char* view_uri, ...) - * API int contacts_db_delete_record(const char* view_uri, ...) - * API int contacts_db_get_all_records(const char* view_uri, ...) - * API int contacts_db_delete_records(const char* view_uri, ...) - * API int contacts_db_add_changed_cb(const char* view_uri, ...) - * API int contacts_db_remove_changed_cb(const char* view_uri, ...) - * API int contacts_db_get_changes_by_version(const char* view_uri, ...) - * API int contacts_db_search_records(const char* view_uri, ...) - * API int contacts_db_search_records_with_range(const char* view_uri, ...) - * API int contacts_db_get_count(const char* view_uri, ...) + * int contacts_record_create(const char* view_uri, ...) + * int contacts_filter_create(const char* view_uri, ...) + * int contacts_query_create(const char* view_uri, ...) + * int contacts_db_get_record(const char* view_uri, ...) + * int contacts_db_delete_record(const char* view_uri, ...) + * int contacts_db_get_all_records(const char* view_uri, ...) + * int contacts_db_delete_records(const char* view_uri, ...) + * int contacts_db_add_changed_cb(const char* view_uri, ...) + * int contacts_db_remove_changed_cb(const char* view_uri, ...) + * int contacts_db_get_changes_by_version(const char* view_uri, ...) + * int contacts_db_search_records(const char* view_uri, ...) + * int contacts_db_search_records_with_range(const char* view_uri, ...) + * int contacts_db_get_count(const char* view_uri, ...) * @endcode * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_RECORDS_HANDLE Record handle * To use a record, you must obtain its handle. * There are many ways to obtains it, including creating a new record and referring to child records of a record.
@@ -316,17 +297,15 @@ * contacts_record_create(_contacts_contact._uri, &contact); * @endcode * - * Sample code: Gets a contact record with id + * Sample code: Gets a contact record with ID * @code * contacts_record_h contact = NULL; * contacts_db_get_record(_contacts_contact._uri, id, &contact); * @endcode * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_RECORDS_BASIC_TYPES Basic types * A record can have basic properties of five types: integer, string, boolean, long integer, lli (long long int), double. * Each property of basic type has functions to operate on it: - * * * * @@ -360,11 +339,10 @@ * * *
Table: Setter and getter functions
@ref contacts_record_get_double
- * * Above functions also require specifying which property you wish to get/set. - * Every getter and setter functions need record and property id. - * You can make property id by combine data-view name and property name. - * (.e.g. property id of a contact display_name property : _contacts_contact.display_name) + * Every getter and setter functions need record and property ID. + * You can make property ID by combine data-view name and property name. + * (.e.g. property ID of a contact display_name property : _contacts_contact.display_name) * * Sample code : Sets the ‘ringtone_path’ property of a contact record. * @code @@ -383,9 +361,9 @@ * contacts_record_get_str(record, _contacts_person.display_name, &display_name); * contacts_record_get_str_p(record, _contacts_person.display_name, &display_name); * @endcode - * In the first case, the returned string should be freed by the application. - * In second one, display_name value will freed automatically when destroying record handle. * + * In the first case, the returned string should be freed by the application. + * In second one, display_name value will freed automatically when destroying the record handle. * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_RECORDS_CHILD Child * A record can have properties of type 'record' called child records. @@ -400,7 +378,7 @@ * contacts_record_h image = NULL; * int contact_id = 0; * - * // image, address record can be child record of contact record + * // Image, address record can be child record of contact record * contacts_record_create(_contacts_contact._uri, &contact); * * contacts_record_create(_contacts_image._uri, &image); @@ -415,17 +393,16 @@ * contacts_record_set_str(address, _contacts_address.country, "Korea"); * contacts_record_add_child_record(contact, _contacts_contact.address, address); * - * // insert contact to DBs + * // Insert contact to DBs * contacts_db_insert_record(contact, &contact_id); * contacts_record_destroy(contact, true); * @endcode * + * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_RECORDS_RECORD_ID_PROPERTY Record ID property + * ID is unique number which can identify a record Therefore, if you know the ID of a record, you can directly handle the record. + * The ID is read-only property, which is available after the record has been inserted into the database. * - * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_RECORDS_RECORD_ID_PROPERTY Record id property - * ID is unique number which can identify a record Therefore, if you know the id of a record, you can directly handle the record. - * The id is read-only property, which is available after the record has been inserted into the database. - * - * Sample code: Gets a contact record with id + * Sample code: Gets a contact record with ID * @code * contacts_record_h contact = NULL; * contacts_record_create(_contacts_contact._uri, &contact); @@ -445,89 +422,84 @@ * contacts_record_destroy(contact, true); // contact is no longer usable * @endcode * - * Identifiers can also be used to establish a relation between two records. The following code sets an address record's 'contact_id' property to the id of the contact. contact_id make relate between the address record and the contact which is identified by the contact_id. After that is done, the address becomes one of the addresses connected to the contact. The address is now the contact's child record, the contact is the parent record. + * Identifiers can also be used to establish a relation between two records. The following code sets an address record's 'contact_id' property to the ID of the contact. contact_id make relate between the address record and the contact which is identified by the contact_id. After that is done, the address becomes one of the addresses connected to the contact. The address is now the contacts child record, the contact is the parent record. * * Sample code: Insert a address record with contact_id * @code - * int contact_id = ... // acquire id of created contact + * int contact_id = ... // Acquire ID of created contact * int address_id = 0; * contacts_record_create(_contacts_address._uri, &address); * contacts_record_set_int(address, _contacts_address.contact_id, contact_id); - * // set other address properties - * // ... + * // Set other address properties + * * contacts_db_insert_record(address, &address_id); * @endcode - * * Having a record handle, you can access all records of a specific type related to the given record. * * Sample code: Gets a contact record * @code - * int contact_id = ... // acquire id of created contact + * int contact_id = ... // Acquire ID of created contact * int address_num = 0; * int i = 0; * contacts_db_get_record(_contacts_contact._uri, contact_id, &contact); * contacts_record_get_child_record_count(contact, _contacts_contact.address, &address_num); * for (i = 0; i < address_num; i++) { - * contacts_record_h address = NULL; - * contacts_record_get_child_record_at_p(contact, _contacts_contact.address, i, &address); - * contacts_record_set_str(address, _contacts_address.country, "Korea"); + * contacts_record_h address = NULL; + * contacts_record_get_child_record_at_p(contact, _contacts_contact.address, i, &address); + * contacts_record_set_str(address, _contacts_address.country, "Korea"); * } * contacts_db_update_record(contact); * contacts_record_destroy(contact, true); * @endcode * * This example is to change a country of addresses which are child records of a contact. Each address can be traversed by using contacts_record_get_child_record_at_p(). It is possible to apply the changes by updating the contact which is the parent record. - * - * - * * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_LISTS Lists * The contacts-service provides functions which can handle list of same type records. Lists concept is based on standard doubly linked list. - * * To operate a list, you must obtain its handle. The handle is provided during creation of the list. List handle must destroy after use. + * * @code - * API int contacts_list_create(contacts_list_h* contacts_list); - * API int contacts_list_destroy(contacts_list_h contacts_list, bool delete_child); + * int contacts_list_create(contacts_list_h* contacts_list); + * int contacts_list_destroy(contacts_list_h contacts_list, bool delete_child); * @endcode * * If ‘delete_child’ parameter is the true, child resources will destroy automatically. * * Sample code: Create a list handle * @code - * // get list handle with query + * // Get list handle with query * contacts_list_h list = NULL; * contacts_list_create(&list); * - * // use list - * // ... + * // Use list * * contacts_list_destroy(list, true); * @endcode * * Sample code: Gets person list handle from database. * @code - * // get list handle with query + * // Get list handle with query * contacts_list_h list = NULL; * contacts_db_get_all_records(_contacts_person._uri, 0, 0, &list); * - * // use list - * // ... + * // Use list * * contacts_list_destroy(list, true); * @endcode * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_LISTS_CURSOR Cursor * The list can be traversed by using cursor. + * * @code - * API int contacts_list_first(contacts_list_h contacts_list); - * API int contacts_list_last(contacts_list_h contacts_list); - * API int contacts_list_next(contacts_list_h contacts_list); - * API int contacts_list_prev(contacts_list_h contacts_list); + * int contacts_list_first(contacts_list_h contacts_list); + * int contacts_list_last(contacts_list_h contacts_list); + * int contacts_list_next(contacts_list_h contacts_list); + * int contacts_list_prev(contacts_list_h contacts_list); * @endcode * * You can get a record of current cursor. + * * @code - * API int contacts_list_get_current_record_p(contacts_list_h contacts_list, contacts_record_h* record); + * int contacts_list_get_current_record_p(contacts_list_h contacts_list, contacts_record_h* record); * @endcode * * Sample code: Loop list @@ -536,22 +508,21 @@ * contacts_record_h record = NULL; * contacts_db_get_all_records(_contacts_person._uri, 0, 0, &list); * do { - * contacts_list_get_current_record_p(list, &record); - * if (NULL == record) - * break; - * char *name = NULL; - * contacts_record_get_str_p(record, _contacts_person.display_name, &name); - * printf(“name=%s\n”, name); + * contacts_list_get_current_record_p(list, &record); + * if (NULL == record) + * break; + * char *name = NULL; + * contacts_record_get_str_p(record, _contacts_person.display_name, &name); + * printf(“name=%s\n”, name); * } while (CONTACTS_ERROR_NONE == contacts_list_next(list)); - * contacts_list_destroy(list, true); // destroy child records automatically + * contacts_list_destroy(list, true); // Destroy child records automatically * @endcode * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_LISTS_ADD_REMOVE Add / Remove * The contacts-service provides functions for adding/removing child record on list. * @code - * API int contacts_list_add(contacts_list_h contacts_list, contacts_record_h record); - * API int contacts_list_remove(contacts_list_h contacts_list, contacts_record_h record); + * int contacts_list_add(contacts_list_h contacts_list, contacts_record_h record); + * int contacts_list_remove(contacts_list_h contacts_list, contacts_record_h record); * @endcode * * Sample code: Adds records to the list @@ -575,16 +546,14 @@ * contacts_list_destroy(list, true); * @endcode * - * - * * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_BULK_APIS Bulk APIs - * Bulk APIs provide to insert/update/delete multiple records. There is no limit of record count on bulk API, but it cause a process to hang during the api is operated. Bulk APIs guarantee atomicity. That is, the api operations either all, or nothing. + * Bulk APIs provide to insert/update/delete multiple records. There is no limit of record count on bulk API, but it causes a process to hang during the time the API is operated. Bulk APIs guarantee atomicity. That is, the API operating either all, or nothing. * * @code - * API int contacts_db_insert_records(contacts_list_h record_list, int **ids, int *count); - * API int contacts_db_update_records(contacts_list_h record_list); - * API int contacts_db_delete_records(const char* view_uri, int record_id_array[], int count); - * API int contacts_db_replace_records(contacts_list_h list, int record_id_array[], int count); + * int contacts_db_insert_records(contacts_list_h record_list, int **ids, int *count); + * int contacts_db_update_records(contacts_list_h record_list); + * int contacts_db_delete_records(const char* view_uri, int record_id_array[], int count); + * int contacts_db_replace_records(contacts_list_h list, int record_id_array[], int count); * @endcode * * Sample code: Insert two contact records using bulk API. @@ -592,14 +561,12 @@ * contacts_record_h contact1; * contacts_record_create(_contacts_contact.uri, &contact1); * - * // fill contact record - * // ... + * // Fill contact record * * contacts_record_h contact2; * contacts_record_create(_contacts_contact._uri, &contact2); * - * // fill contact record - * // ... + * // Fill contact record * * contacts_list_h list = NULL; * contacts_list_create(&list); @@ -610,28 +577,25 @@ * int **ids = NULL; * int count = 0; * - * // Insert conact records using bulk API + * // Insert contact records using bulk API * contacts_db_insert_records(list, &ids, &count); * - * // use ids - * // ... + * // Use IDs * * contacts_list_destroy(list, true); * free(ids); * @endcode * - * - * * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_FILTER_AND_QUERIES Queries * Queries are used to retrieve data which satisfies given criteria, like an integer property being greater than a given value, or a string property containing a given substring. Query needs a filter which can set the condition for search. The contacts-service provides query APIs for sorting, set projection and removing duplicated results. * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_FILTER_AND_QUERIES_FILTER Filter * The contacts Filter API provides the set of definitions and interfaces that enable application developers to make filters to set query.
* When creating a filter, you need to specify what type of filter you want to create using _uri property. Filter handle must destroy after use. + * * @code - * API int contacts_filter_create(const char* view_uri, contacts_filter_h* filter); - * API int contacts_filter_destroy(contacts_filter_h filter); + * int contacts_filter_create(const char* view_uri, contacts_filter_h* filter); + * int contacts_filter_destroy(contacts_filter_h filter); * @endcode * * Sample code: Set filter condition to contain a given substring. @@ -709,7 +673,7 @@ * * * - * Sample code: Create a filter which will accept addresses with their contact's id equal to a given id (integer filter), or their country property equal to "Korea" (string filter). Create a query and add the filter to it. Results are received in a list. + * Sample code: Create a filter which will accept addresses with their contacts ID equal to a given ID (integer filter), or their country property equal to "Korea" (string filter). Create a query and add the filter to it. Results are received in a list. * @code * contacts_filter_h filter = NULL; * contacts_list_h list = NULL; @@ -727,18 +691,17 @@ * contacts_filter_destroy(filter); * contacts_query_destroy(query); * - * // use the list - * // ... + * // Use the list * * contacts_list_destroy(list, true); * * @endcode * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_FILTER_AND_QUERIES_SORT Sort * Query results list can sort by property id. + * * @code - * API int contacts_query_set_sort(contacts_query_h query, unsigned int property_id, bool is_ascending); + * int contacts_query_set_sort(contacts_query_h query, unsigned int property_id, bool is_ascending); * @endcode * * Sample code: Sort to query result by person id @@ -754,49 +717,47 @@ * contacts_list_destroy(person_list, true); * @endcode * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_FILTER_AND_QUERIES_PROJECTION Projection * Projection allows you to query the Data for just those specific properties of a record that you actually need, at lower latency and cost than retrieving the entire properties. + * * @code - * API int contacts_query_set_projection(contacts_query_h query, unsigned int property_ids[], int count) + * int contacts_query_set_projection(contacts_query_h query, unsigned int property_ids[], int count) * @endcode * * Sample code: Creates a filter which will get only person id, display name, image thumbnail path from the person record with its vibration path has “test” (string filter). Create a query and add the filter to it. Results are received in a list. * @code - * contacts_filter_add_str (filter, _contacts_person.vibration, CONTACTS_MATCH_CONTAINS, "test"); + * contacts_filter_add_str(filter, _contacts_person.vibration, CONTACTS_MATCH_CONTAINS, "test"); * contacts_query_set_filter(query, filter); * - * //set projections to get + * // Set projections to get * unsigned int person_projection[] = { - * _contacts_person.id, - * _contacts_person.display_name, - * _contacts_person.image_thumbnail_path, + * _contacts_person.id, + * _contacts_person.display_name, + * _contacts_person.image_thumbnail_path, * }; * contacts_query_set_projection(query, person_projection, sizeof(person_projection)/sizeof(int)); * * contacts_db_get_records_with_query(query, 0, 0, &person_list); * - * // use list - * // ... + * // Use list * * contacts_query_destroy(query); * contacts_filter_destroy(filter); * contacts_list_destroy(person_list, true); * @endcode * - * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_FILTER_AND_QUERIES_DISTINCT Distinct * If you query to some read-only view with set projection, result list can contain duplicates. You can remove duplicates using _contacts_query_set_distinct. + * * @code - * API int contacts_query_set_distinct(contacts_query_h query, bool set) + * int contacts_query_set_distinct(contacts_query_h query, bool set) * endcode * * Sample code: Remove duplicates * @code * unsigned int projection[] = { - * _contacts_person_number.person_id, - * _contacts_person_number.display_name, + * _contacts_person_number.person_id, + * _contacts_person_number.display_name, * }; * contacts_filter_create(_contacts_person_number._uri, &filter); * contacts_filter_add_bool(filter, _contacts_person_number.has_phonenumber, true); @@ -805,49 +766,44 @@ * contacts_query_set_projection(query, projection, sizeof(projection)/sizeof(int)); * contacts_query_set_filter(query, filter); * - * // set distinct (remove duplicats) + * // Set distinct (remove duplicates) * contacts_query_set_distinct(query, true); * * contacts_db_get_records_with_query(query, 0, 0, &list); * - * // use list - * // ... + * // Use list * * contacts_list_destroy(list, true); * contacts_query_destroy(query); * contacts_filter_destroy(filter); * @endcode * - * - * * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_DATABASE_CHANGE_NOTIFICATIONS Database Change Notifications * Applications add/remove callback function to detect/ignore the contacts DB changes with contacts_db_add_changed_cb() / contacts_db_remove_changed_cb().
* Clients wait contacts change notification on client side.
- * If contacts is changed by another module, server publishes notification. The notification will be broadcast to subscribed modules. Finally, user callback function is called with user data. + * If contact is changed by another module, server publishes notification. The notification will be broadcast to subscribed modules. Finally, user callback function is called with user data. * * Sample code: Register person changes notification callback * @code - * // callback function - * static void __person_changed_ cb(const char *view_uri, void *user_data) + * // Callback function + * static void + * __person_changed_cb(const char *view_uri, void *user_data) * { - * // jobs for callback + * // Jobs for callback * } - * // add changed noti callback - * contacts_db_add_changed_cb(_contacts_person._uri, __person_changed_cb, NULL); + * // Add changed noti callback + * contacts_db_add_changed_cb(_contacts_person._uri, __person_changed_cb, NULL); * @endcode * - * - * * @section CAPI_SOCIAL_CONTACTS_SVC_MODULE_VCARD vCard * Contacts-service provides methods for parsing and making vCard . vCard APIs based on vCard v3.0 specification. For more information about vCard, refer to rfc2426 (http://www.ietf.org/rfc/rfc2426.txt) * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_VCARD_PARSING_VCARD Parsing vCard * There are two ways for parsing vCard. * * Sample code: Parsing vCard from stream then insert to database. * @code - * // make contact record list from vcard stream + * // Make contact record list from vcard stream * contacts_list_h list = NULL; * contacts_vcard_parse_to_contacts(vcard_stream, &list); * @@ -855,8 +811,7 @@ * int count = 0; * contacts_db_insert_records(list, &ids, &count); * - * // use ids, count - * // ... + * // Use IDs, count * * free(ids); * contacts_list_destroy(list, true); @@ -864,18 +819,19 @@ * * Sample code: Parsing vCard from file then insert to database * @code - * // called to get a record handle of _contacts_contact view - * static bool __vcard_parse_cb(contacts_record_h record, void *user_data) + * // Called to get a record handle of _contacts_contact view + * static bool + * __vcard_parse_cb(contacts_record_h record, void *user_data) * { - * int id = 0; - * contacts_db_insert_record(record, &id); + * int id = 0; + * contacts_db_insert_record(record, &id); * - * // return false to break out of the loop - * // return true to continue with the next iteration of the loop - * return true; + * // Return false to break out of the loop + * // Return true to continue with the next iteration of the loop + * return true; * } * - * // parse vCard from file + * // Parse vCard from file * char *resource_path = app_get_resource_path(); * char vcard_path[1024] = {0}; * snprintf(vcard_path, sizeof(vcard_path), "%s/vcard.vcf", resource_path); @@ -883,7 +839,6 @@ * contacts_vcard_parse_to_contact_foreach(vcard_path, __vcard_parse_cb, NULL); * @endcode * - * * @subsection CAPI_SOCIAL_CONTACTS_SVC_MODULE_VCARD_MAKING_VCARD_STREAM Making vCard stream * You can make vcard stream from contact, person or my profile record. * @@ -895,14 +850,13 @@ * contacts_db_get_record(_contacts_contact._uri, contact_id, &contact); * contacts_vcard_make_from_contact(contact, &vcard_stream); * - * // use the vcard stream - * // ... + * // Use the vcard stream * * free(vcard_stream); * contacts_record_destroy(contact, true); * @endcode - * */ + #endif /* __TIZEN_SOCIAL_CONTACTS_DOC_H__ */ diff --git a/include/contacts.h b/include/contacts.h index 8f6152c..d1740cc 100644 --- a/include/contacts.h +++ b/include/contacts.h @@ -16,9 +16,12 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_H__ #define __TIZEN_SOCIAL_CONTACTS_H__ + #include #include #include @@ -37,5 +40,6 @@ #include #include + #endif /*__TIZEN_SOCIAL_CONTACTS_H__ */ diff --git a/include/contacts_activity.h b/include/contacts_activity.h index 04cd922..f8c9e38 100644 --- a/include/contacts_activity.h +++ b/include/contacts_activity.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_ACTIVITY_H__ #define __TIZEN_SOCIAL_CONTACTS_ACTIVITY_H__ @@ -25,76 +27,66 @@ extern "C" { #endif + /** * @file contacts_activity.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_ACTIVITY_MODULE Activity - * * @brief The contacts activity API provides the set of definitions and interfaces that enable application developers to delete activities by @a contact_id and @a account_id. \n * For more details, see @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity. - * * @section CAPI_SOCIAL_CONTACTS_SVC_ACTIVITY_MODULE_HEADER Required Header - * \#include - * + * \#include *
* @{ */ + /** * @brief Deletes an activity record from the contacts database by contact ID. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] contact_id The contact ID to delete - * - * @return @c 0 on success, - * otherwise a negative error value (#contacts_error_e) - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] contact_id The contact ID to delete + * @return @c 0 on success, + * otherwise a negative error value (#contacts_error_e) + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_activity_delete_by_contact_id(int contact_id); + /** * @brief Deletes an activity record from the contacts database by account ID. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] account_id The account ID to delete - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] account_id The account ID to delete + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_activity_delete_by_account_id(int account_id); + /** * @} */ diff --git a/include/contacts_db.h b/include/contacts_db.h index e052744..ccbfffb 100644 --- a/include/contacts_db.h +++ b/include/contacts_db.h @@ -19,90 +19,79 @@ #ifndef __TIZEN_SOCIAL_CONTACTS_DB_H__ #define __TIZEN_SOCIAL_CONTACTS_DB_H__ + #ifdef __cplusplus extern "C" { #endif + /** * @file contacts_db.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_DATABASE_MODULE Database - * * @brief The contacts database API provides the set of definitions and interfaces that enable application developers to handle contacts database. - * * @section CAPI_SOCIAL_CONTACTS_SVC_DATABASE_MODULE_HEADER Required Header - * \#include - * + * \#include *
* @{ */ + /** * @brief Enumeration for contact change state. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_CHANGE_INSERTED, /**< Inserted */ - CONTACTS_CHANGE_UPDATED, /**< Updated */ - CONTACTS_CHANGE_DELETED, /**< Deleted */ + CONTACTS_CHANGE_INSERTED, /**< Inserted */ + CONTACTS_CHANGE_UPDATED, /**< Updated */ + CONTACTS_CHANGE_DELETED, /**< Deleted */ } contacts_changed_e; + /** * @brief Called when the designated view changes. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] view_uri The view URI - * @param[in] user_data The user data passed from the callback registration function - * - * @pre The callback must be registered using contacts_db_add_changed_cb. - * + * @param[in] view_uri The view URI + * @param[in] user_data The user data passed from the callback registration function + * @pre The callback must be registered using contacts_db_add_changed_cb. * @see contacts_db_add_changed_cb() */ typedef void (*contacts_db_changed_cb)(const char *view_uri, void *user_data); + /** * @brief Inserts a record to the contacts database. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write * @privilege %http://tizen.org/privilege/callhistory.write - * - * @remarks - * %http://tizen.org/privilege/contact.write is needed for record which is created with @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, \n @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n\n - * %http://tizen.org/privilege/callhistory.write is needed for record which is created with @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. - * - * @param[in] record The record handle - * @param[out] id The ID of inserted record - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_db_changed_cb() callback wil be called upon success. - * + * @remarks %http://tizen.org/privilege/contact.write is needed for record which is created with @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, \n @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n + * %http://tizen.org/privilege/callhistory.write is needed for record which is created with @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. + * @param[in] record The record handle + * @param[out] id The ID of inserted record + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_db_changed_cb() callback wil be called upon success. * @see contacts_connect() * @see contacts_db_update_record() * @see contacts_db_delete_record() @@ -110,86 +99,72 @@ typedef void (*contacts_db_changed_cb)(const char *view_uri, void *user_data); */ int contacts_db_insert_record(contacts_record_h record, int *id); + /** * @brief Gets a record from the contacts database. - * * @details This function creates a new contact handle from the contacts database by the given @a record_id. \n * @a record will be created, which is filled with contact information. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * @privilege %http://tizen.org/privilege/callhistory.read - * * @remarks %http://tizen.org/privilege/contact.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn. \n\n - * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. - * + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn. \n + * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. * @remarks You must release @a record using contacts_record_destroy(). - * - * @param[in] view_uri The view URI of a record - * @param[in] record_id The record ID to get from database - * @param[out] record The record handle associated with the record ID - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[in] view_uri The view URI of a record + * @param[in] record_id The record ID to get from database + * @param[out] record The record handle associated with the record ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_record_destroy() */ int contacts_db_get_record(const char *view_uri, int record_id, contacts_record_h *record); + /** * @brief Updates a record in the contacts database. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write * @privilege %http://tizen.org/privilege/callhistory.write - * * @remarks %http://tizen.org/privilege/contact.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, \n @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n\n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n * %http://tizen.org/privilege/callhistory.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. - * - * @param[in] record The record handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_db_changed_cb() callback wil be called upon success. - * + * @param[in] record The record handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_db_changed_cb() callback wil be called upon success. * @see contacts_connect() * @see contacts_db_insert_record() * @see contacts_db_delete_record() @@ -197,77 +172,64 @@ int contacts_db_get_record(const char *view_uri, int record_id, contacts_record_ */ int contacts_db_update_record(contacts_record_h record); + /** * @brief Deletes a record from the contacts database with related child records. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write * @privilege %http://tizen.org/privilege/callhistory.write - * * @remarks %http://tizen.org/privilege/contact.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, \n @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n\n - * %http://tizen.org/privilege/callhistory.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. - * - * @param[in] view_uri The view URI of a record - * @param[in] record_id The record ID to delete - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_db_changed_cb() callback wil be called upon success. - * + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n + * %http://tizen.org/privilege/callhistory.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. + * @param[in] view_uri The view URI of a record + * @param[in] record_id The record ID to delete + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_db_changed_cb() callback wil be called upon success. * @see contacts_connect() * @see contacts_db_insert_record() */ int contacts_db_delete_record(const char *view_uri, int record_id); + /** * @brief Replaces an id-identified record with the given record. - * * @details Now, this API supports only _contacts_contact view_uri. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @remarks The write-once value of @a record is not replaced.\n - * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact - * - * @param[in] record The new record handle to replace - * @param[in] id The DB record ID to be replaced - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_db_changed_cb() callback wil be called upon success. - * + * @remarks The write-once value of @a record is not replaced. \n + * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact + * @param[in] record The new record handle to replace + * @param[in] id The DB record ID to be replaced + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_db_changed_cb() callback wil be called upon success. * @see contacts_connect() * @see contacts_db_update_record() * @see contacts_db_delete_record() @@ -275,248 +237,212 @@ int contacts_db_delete_record(const char *view_uri, int record_id); */ int contacts_db_replace_record(contacts_record_h record, int id); + /** * @brief Retrieves all records and returns the results list. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - *@privilege %http://tizen.org/privilege/callhistory.read - * + * @privilege %http://tizen.org/privilege/callhistory.read * @remarks You must release @a record_list using contacts_list_destroy(). \n - * %http://tizen.org/privilege/contact.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn and all read-only views except views which are related to phone log. \n\n - * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log_stat. \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_phone_log view is needed both privileges. - * - * @param[in] view_uri The view URI to get records - * @param[in] offset The index from which to get results - * @param[in] limit The number to limit results(value 0 is used for all records) - * @param[out] record_list The record list - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * %http://tizen.org/privilege/contact.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn and all read-only views except views which are related to phone log. \n + * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log_stat. \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_phone_log view is needed both privileges. + * @param[in] view_uri The view URI to get records + * @param[in] offset The index from which to get results + * @param[in] limit The number to limit results(value 0 is used for all records) + * @param[out] record_list The record list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_list_destroy() */ int contacts_db_get_all_records(const char *view_uri, int offset, int limit, contacts_list_h *record_list); + /** * @brief Uses a query to find records. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * @privilege %http://tizen.org/privilege/callhistory.read - * + * @privilege %http://tizen.org/privilege/callhistory.read * @remarks You must release @a record_list using contacts_list_destroy(). \n - * %http://tizen.org/privilege/contact.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn and all read-only views except views which are related to phone log. \n\n - * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log_stat. \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_phone_log view is needed both privileges. - * - * @param[in] query The query to filter the results - * @param[in] offset The index from which to get results - * @param[in] limit The number to limit results(value 0 is used for get all records) - * @param[out] record_list The record list - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * %http://tizen.org/privilege/contact.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn and all read-only views except views which are related to phone log. \n + * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log_stat. \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_phone_log view is needed both privileges. + * @param[in] query The query to filter the results + * @param[in] offset The index from which to get results + * @param[in] limit The number to limit results(value 0 is used for get all records) + * @param[out] record_list The record list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_list_destroy() */ int contacts_db_get_records_with_query(contacts_query_h query, int offset, int limit, contacts_list_h *record_list); + /** * @brief Inserts multiple records to the contacts database. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write * @privilege %http://tizen.org/privilege/callhistory.write - * * @remarks %http://tizen.org/privilege/contact.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, \n @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n\n - * %http://tizen.org/privilege/callhistory.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. - * - * @param[in] record_list The record list handle - * @param[out] ids The IDs of inserted records - * @param[out] count The number of IDs - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_db_changed_cb() callback wil be called upon success. - * + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n + * %http://tizen.org/privilege/callhistory.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. + * @param[in] record_list The record list handle + * @param[out] ids The IDs of inserted records + * @param[out] count The number of IDs + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_db_changed_cb() callback wil be called upon success. * @see contacts_connect() * @see contacts_db_update_records() * @see contacts_db_delete_records() */ int contacts_db_insert_records(contacts_list_h record_list, int **ids, int *count); + /** * @brief Updates multiple records in the contacts database. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write * @privilege %http://tizen.org/privilege/callhistory.write - * * @remarks %http://tizen.org/privilege/contact.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, \n @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n\n - * %http://tizen.org/privilege/callhistory.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. - * - * @param[in] record_list The record list handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_db_changed_cb() callback wil be called upon success. - * + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n + * %http://tizen.org/privilege/callhistory.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. + * @param[in] record_list The record list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_db_changed_cb() callback wil be called upon success. * @see contacts_connect() * @see contacts_db_insert_records() * @see contacts_db_delete_records() */ int contacts_db_update_records(contacts_list_h record_list); + /** * @brief Deletes multiple records in the contacts database with related child records. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write * @privilege %http://tizen.org/privilege/callhistory.write - * * @remarks %http://tizen.org/privilege/contact.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, \n @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n\n - * %http://tizen.org/privilege/callhistory.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. - * - * @param[in] view_uri The view URI of records - * @param[in] record_id_array The record IDs to delete - * @param[in] count The size of record ID array - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_db_changed_cb() callback wil be called upon success. - * + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial. \n + * %http://tizen.org/privilege/callhistory.write is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. + * @param[in] view_uri The view URI of records + * @param[in] record_id_array The record IDs to delete + * @param[in] count The size of record ID array + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_db_changed_cb() callback wil be called upon success. * @see contacts_connect() * @see contacts_db_insert_records() * @see contacts_db_update_records() */ int contacts_db_delete_records(const char *view_uri, int record_id_array[], int count); + /** * @brief Replaces database records identified by given ids with a given record list. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @remarks The write-once value of record is not replaced.\n - * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact - * - * @param[in] list The new record list handle to replace - * @param[in] record_id_array The record IDs to replace - * @param[in] count The size of record ID array - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_db_changed_cb() callback wil be called upon success. - * + * @remarks The write-once value of record is not replaced. \n + * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact + * @param[in] list The new record list handle to replace + * @param[in] record_id_array The record IDs to replace + * @param[in] count The size of record ID array + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_db_changed_cb() callback wil be called upon success. * @see contacts_connect() * @see contacts_db_update_record() * @see contacts_db_delete_record() @@ -524,139 +450,116 @@ int contacts_db_delete_records(const char *view_uri, int record_id_array[], int */ int contacts_db_replace_records(contacts_list_h list, int record_id_array[], int count); + /** * @brief Gets the current contacts database version. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * @privilege %http://tizen.org/privilege/callhistory.read - * - * @param[out] contacts_db_version The contacts database version - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[out] contacts_db_version The contacts database version + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_db_get_changes_by_version() */ int contacts_db_get_current_version(int *contacts_db_version); + /** * @brief Registers a callback function to be invoked when a record changes. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * @privilege %http://tizen.org/privilege/callhistory.read - * * @remarks %http://tizen.org/privilege/contact.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group_relation.\n\n - * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. - * If successive change notification produced on the view_uri are identical, - * then they are coalesced into a single notification if the older notification has not yet been called - * because default main loop is doing something. - * But, it means that a callback function is not called to reliably count of change. - * - * @param[in] view_uri The view URI of records whose changes are monitored - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_SYSTEM System error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_db_changed_cb() will be invoked when the designated view changes. - * + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group_relation.\n + * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log. + * If successive change notification produced on the view_uri are identical, + * then they are coalesced into a single notification if the older notification has not yet been called + * because default main loop is doing something. + * But, it means that a callback function is not called to reliably count of change. + * @param[in] view_uri The view URI of records whose changes are monitored + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_SYSTEM System error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_db_changed_cb() will be invoked when the designated view changes. * @see contacts_connect() * @see contacts_db_changed_cb() * @see contacts_db_remove_changed_cb() */ int contacts_db_add_changed_cb(const char *view_uri, contacts_db_changed_cb callback, void *user_data); + /** * @brief Unregisters a callback function. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] view_uri The view URI of records whose changes are monitored - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_SYSTEM System error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[in] view_uri The view URI of records whose changes are monitored + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_SYSTEM System error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_db_changed_cb() * @see contacts_db_add_changed_cb() */ int contacts_db_remove_changed_cb(const char *view_uri, contacts_db_changed_cb callback, void *user_data); + /** * @brief Retrieves records changes since the given database version. - * * @details This function will find all changed records since the given @a contacts_db_version. \n * Now, support @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact_updated_info, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group_updated_info \n * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile_updated_info and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_grouprel_updated_info. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * * @remarks You must release @a record_list using contacts_list_destroy(). - * - * @param[in] view_uri The view URI to get records - * @param[in] address_book_id The address book ID to filter - * @param[in] contacts_db_version The contacts database version - * @param[out] change_record_list The record list - * @param[out] current_contacts_db_version The current contacts database version - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[in] view_uri The view URI to get records + * @param[in] address_book_id The address book ID to filter + * @param[in] contacts_db_version The contacts database version + * @param[out] change_record_list The record list + * @param[out] current_contacts_db_version The current contacts database version + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_list_destroy() */ @@ -666,350 +569,299 @@ int contacts_db_get_changes_by_version(const char *view_uri, contacts_list_h *change_record_list, int *current_contacts_db_version); + /** * @brief Finds records based on a given keyword. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * * @remarks You must release @a record_list using contacts_list_destroy(). \n - * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n - * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. - * - * @param[in] view_uri The view URI to get records - * @param[in] keyword The keyword - * @param[in] offset The index from which to get results - * @param[in] limit The number to limit results(value 0 is used for get all records) - * @param[out] record_list The record list - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n + * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. + * @param[in] view_uri The view URI to get records + * @param[in] keyword The keyword + * @param[in] offset The index from which to get results + * @param[in] limit The number to limit results(value 0 is used for get all records) + * @param[out] record_list The record list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_list_destroy() */ int contacts_db_search_records(const char *view_uri, const char *keyword, int offset, int limit, contacts_list_h *record_list); + /** * @brief Finds records based on given query and keyword. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * * @remarks You must release @a record_list using contacts_list_destroy(). \n - * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n - * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned - * - * @param[in] query The query handle to filter - * @param[in] keyword The keyword - * @param[in] offset The index from which to get results - * @param[in] limit The number to limit results(value 0 used for get all records) - * @param[out] record_list The record list - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n + * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. + * @param[in] query The query handle to filter + * @param[in] keyword The keyword + * @param[in] offset The index from which to get results + * @param[in] limit The number to limit results(value 0 used for get all records) + * @param[out] record_list The record list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_list_destroy() */ int contacts_db_search_records_with_query(contacts_query_h query, const char *keyword, int offset, int limit, contacts_list_h *record_list); + /** * @brief Finds records based on a keyword and range. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * * @remarks You must release @a record_list using contacts_list_destroy(). \n - * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. These views can search records with range @ref CONTACTS_SEARCH_RANGE_NAME, @ref CONTACTS_SEARCH_RANGE_NUMBER, @ref CONTACTS_SEARCH_RANGE_DATA. \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_number can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_NUMBER.\n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_email can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_EMAIL. \n - * - * @param[in] view_uri The view URI - * @param[in] keyword The keyword - * @param[in] offset The index from which to get results - * @param[in] limit The number to limit results(value 0 is used for get all records) - * @param[in] range The search range - * @param[out] record_list The record list - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. These views can search records with range @ref CONTACTS_SEARCH_RANGE_NAME, @ref CONTACTS_SEARCH_RANGE_NUMBER, @ref CONTACTS_SEARCH_RANGE_DATA. \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_number can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_NUMBER.\n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_email can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_EMAIL. + * @param[in] view_uri The view URI + * @param[in] keyword The keyword + * @param[in] offset The index from which to get results + * @param[in] limit The number to limit results(value 0 is used for get all records) + * @param[in] range The search range + * @param[out] record_list The record list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_list_destroy() */ int contacts_db_search_records_with_range(const char *view_uri, const char *keyword, int offset, int limit, int range, contacts_list_h *record_list); + /** * @brief Finds records based on a given keyword for snippet. - * * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * * @remarks You must release @a record_list using contacts_list_destroy(). \n - * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n - * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned - * - * @param[in] view_uri The view URI to get records - * @param[in] keyword The keyword - * @param[in] offset The index from which to get results - * @param[in] limit The number to limit results(value 0 used for get all records) - * @param[in] start_match The text which is inserted into the fragment before the keyword(If NULL, default is "[") - * @param[in] end_match The text which is inserted into the fragment after the keyword(If NULL, default is "]") - * @param[in] token_number The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") - * @param[out] record_list The record list - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n + * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. + * @param[in] view_uri The view URI to get records + * @param[in] keyword The keyword + * @param[in] offset The index from which to get results + * @param[in] limit The number to limit results(value 0 used for get all records) + * @param[in] start_match The text which is inserted into the fragment before the keyword(If NULL, default is "[") + * @param[in] end_match The text which is inserted into the fragment after the keyword(If NULL, default is "]") + * @param[in] token_number The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") + * @param[out] record_list The record list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_list_destroy() */ int contacts_db_search_records_for_snippet(const char *view_uri, const char *keyword, int offset, int limit, const char *start_match, const char *end_match, int token_number, contacts_list_h *record_list); + /** * @brief Finds records based on given query and keyword for snippet. - * * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * * @remarks You must release @a record_list using contacts_list_destroy(). \n - * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n - * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned - * - * @param[in] query The query handle to filter - * @param[in] keyword The keyword - * @param[in] offset The index from which to get results - * @param[in] limit The number to limit results(value 0 used for get all records) - * @param[in] start_match The text which is inserted into the fragment before the keyword(If NULL, default is "[") - * @param[in] end_match The text which is inserted into the fragment after the keyword(If NULL, default is "]") - * @param[in] token_number The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") - * @param[out] record_list The record list - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n + * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. + * @param[in] query The query handle to filter + * @param[in] keyword The keyword + * @param[in] offset The index from which to get results + * @param[in] limit The number to limit results(value 0 used for get all records) + * @param[in] start_match The text which is inserted into the fragment before the keyword(If NULL, default is "[") + * @param[in] end_match The text which is inserted into the fragment after the keyword(If NULL, default is "]") + * @param[in] token_number The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") + * @param[out] record_list The record list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_list_destroy() */ - int contacts_db_search_records_with_query_for_snippet(contacts_query_h query, const char *keyword, int offset, int limit, const char *start_match, const char *end_match, int token_number, contacts_list_h *record_list); + /** * @brief Finds records based on a keyword and range for snippet. - * * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * * @remarks You must release @a record_list using contacts_list_destroy(). \n - * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. These views can search records with range @ref CONTACTS_SEARCH_RANGE_NAME, @ref CONTACTS_SEARCH_RANGE_NUMBER, @ref CONTACTS_SEARCH_RANGE_DATA. \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_number can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_NUMBER.\n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_email can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_EMAIL. \n - * - * @param[in] view_uri The view URI - * @param[in] keyword The keyword - * @param[in] offset The index from which to get results - * @param[in] limit The number to limit results(value 0 is used for get all records) - * @param[in] range The search range - * @param[in] start_match The text which is inserted into the fragment before the keyword(If NULL, default is "[") - * @param[in] end_match The text which is inserted into the fragment after the keyword(If NULL, default is "]") - * @param[in] token_number The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") - * @param[out] record_list The record list - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. These views can search records with range @ref CONTACTS_SEARCH_RANGE_NAME, @ref CONTACTS_SEARCH_RANGE_NUMBER, @ref CONTACTS_SEARCH_RANGE_DATA. \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_number can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_NUMBER.\n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_email can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_EMAIL. + * @param[in] view_uri The view URI + * @param[in] keyword The keyword + * @param[in] offset The index from which to get results + * @param[in] limit The number to limit results(value 0 is used for get all records) + * @param[in] range The search range + * @param[in] start_match The text which is inserted into the fragment before the keyword(If NULL, default is "[") + * @param[in] end_match The text which is inserted into the fragment after the keyword(If NULL, default is "]") + * @param[in] token_number The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") + * @param[out] record_list The record list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_list_destroy() */ int contacts_db_search_records_with_range_for_snippet(const char *view_uri, const char *keyword, int offset, int limit, int range, const char *start_match, const char *end_match, int token_number, contacts_list_h *record_list); + /** * @brief Gets the number of records in a specific view. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * @privilege %http://tizen.org/privilege/callhistory.read - * - * @remarks %http://tizen.org/privilege/contact.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn and all read-only views except views which is related to phone log. \n\n - * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log_stat. \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_phone_log view is needed both privilege. - * - * @param[in] view_uri The view URI - * @param[out] count The count of records - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @remarks %http://tizen.org/privilege/contact.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn and all read-only views except views which is related to phone log. \n + * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log_stat. \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_phone_log view is needed both privilege. + * @param[in] view_uri The view URI + * @param[out] count The count of records + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() */ int contacts_db_get_count(const char *view_uri, int *count); + /** * @brief Gets the number of records matching a query. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * @privilege %http://tizen.org/privilege/callhistory.read - * * @remarks %http://tizen.org/privilege/contact.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address_book, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn and all read-only views except views which is related to phone log. \n\n - * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log_stat. \n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_phone_log view is needed both privilege. - * - * @param[in] query The query handle - * @param[out] count The count of records - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_name, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo, \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn and all read-only views except views which is related to phone log. \n + * %http://tizen.org/privilege/callhistory.read is needed for record which is related to @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log_stat. \n + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_phone_log view is needed both privilege. + * @param[in] query The query handle + * @param[out] count The count of records + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() */ int contacts_db_get_count_with_query(contacts_query_h query, int *count); + /** * @brief Gets the last successful changed contacts database version on the current connection. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * @privilege %http://tizen.org/privilege/callhistory.read - * - * @param[out] last_change_version The database version - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[out] last_change_version The database version + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_db_get_current_version() */ int contacts_db_get_last_change_version(int *last_change_version); + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_DB_H__ */ diff --git a/include/contacts_db_status.h b/include/contacts_db_status.h index d97d57e..eb8d133 100644 --- a/include/contacts_db_status.h +++ b/include/contacts_db_status.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_DB_STATUS_H__ #define __TIZEN_SOCIAL_CONTACTS_DB_STATUS_H__ @@ -25,113 +27,95 @@ extern "C" { #endif + /** * @file contacts_db_status.h */ + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_DATABASE_MODULE * @{ */ + /** * @brief Enumeration for contact DB status. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * */ - typedef enum { - CONTACTS_DB_STATUS_NORMAL, /**< Normal */ + CONTACTS_DB_STATUS_NORMAL, /**< Normal */ CONTACTS_DB_STATUS_CHANGING_COLLATION, /**< DB status is Changing collation */ } contacts_db_status_e; + /** - * @brief Gets the current status of server. - * + * @brief Gets the current status of server. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] status The current status of server - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * - * @pre This function requires an open connection to the contacts service by contacts_connect(). - * + * @param[in] status The current status of server + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @pre This function requires an open connection to the contacts service by contacts_connect(). * @see contacts_connect() */ - int contacts_db_get_status(contacts_db_status_e *status); + /** - * @brief Called when contacts-service server status changes. - * + * @brief Called when contacts-service server status changes. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] status The current status of server - * @param[in] user_data The user data passed from the callback registration function - * - * @pre This function requires an open connection to contacts service by contacts_connect(). - * + * @param[in] status The current status of server + * @param[in] user_data The user data passed from the callback registration function + * @pre This function requires an open connection to contacts service by contacts_connect() * @see contacts_db_add_status_changed_cb() */ - typedef void (*contacts_db_status_changed_cb)(contacts_db_status_e status, void *user_data); + /** - * @brief Registers a callback function. - * + * @brief Registers a callback function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * - * @pre This function requires an open connection to the contacts service by contacts_connect(). - * + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @pre This function requires an open connection to the contacts service by contacts_connect(). * @see contacts_connect() * @see contacts_db_remove_status_changed_cb() */ - int contacts_db_add_status_changed_cb(contacts_db_status_changed_cb callback, void *user_data); + /** - * @brief Unregisters a callback function. - * + * @brief Unregisters a callback function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * - * @pre This function requires an open connection to the contacts service by contacts_connect(). - * + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @pre This function requires an open connection to the contacts service by contacts_connect(). * @see contacts_connect() * @see contacts_db_add_status_changed_cb() */ - int contacts_db_remove_status_changed_cb(contacts_db_status_changed_cb callback, void *user_data); + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_DB_STATUS_H__ */ diff --git a/include/contacts_errors.h b/include/contacts_errors.h index 16e48ec..053e763 100644 --- a/include/contacts_errors.h +++ b/include/contacts_errors.h @@ -17,66 +17,73 @@ * */ + #ifndef __TIZEN_SOCIAL_CONTACTS_ERROR_H__ #define __TIZEN_SOCIAL_CONTACTS_ERROR_H__ + #include + #ifdef __cplusplus extern "C" { #endif + /** * @file contacts_errors.h */ + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_COMMON_MODULE * @{ */ + /** * @brief Enumeration for contacts errors. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { /* GENERAL */ - CONTACTS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ - CONTACTS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ - CONTACTS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ - CONTACTS_ERROR_FILE_NO_SPACE = TIZEN_ERROR_FILE_NO_SPACE_ON_DEVICE, /**< FS Full */ - CONTACTS_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ - CONTACTS_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ + CONTACTS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + CONTACTS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ + CONTACTS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ + CONTACTS_ERROR_FILE_NO_SPACE = TIZEN_ERROR_FILE_NO_SPACE_ON_DEVICE, /**< FS Full */ + CONTACTS_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ + CONTACTS_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ /* LOGIC & DATA */ - CONTACTS_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA, /**< Requested data does not exist */ + CONTACTS_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA, /**< Requested data does not exist */ /* DB */ - CONTACTS_ERROR_DB_LOCKED = TIZEN_ERROR_CONTACTS | 0x81, /**< Database table locked or file locked */ - CONTACTS_ERROR_DB = TIZEN_ERROR_CONTACTS | 0x9F, /**< Unknown DB error */ + CONTACTS_ERROR_DB_LOCKED = TIZEN_ERROR_CONTACTS | 0x81, /**< Database table locked or file locked */ + CONTACTS_ERROR_DB = TIZEN_ERROR_CONTACTS | 0x9F, /**< Unknown DB error */ /* IPC */ - CONTACTS_ERROR_IPC_NOT_AVALIABLE = TIZEN_ERROR_CONTACTS | 0xB1, /**< IPC server is not available */ - CONTACTS_ERROR_IPC = TIZEN_ERROR_CONTACTS | 0xBF, /**< Unknown IPC error */ + CONTACTS_ERROR_IPC_NOT_AVALIABLE = TIZEN_ERROR_CONTACTS | 0xB1, /**< IPC server is not available */ + CONTACTS_ERROR_IPC = TIZEN_ERROR_CONTACTS | 0xBF, /**< Unknown IPC error */ /* ENVIRONMENT & OTHER MODULE */ /* Socket, inotify, vconf, icu, tapi, security/smack, account and so on */ - CONTACTS_ERROR_SYSTEM = TIZEN_ERROR_CONTACTS | 0xEF, /**< Internal system module error */ + CONTACTS_ERROR_SYSTEM = TIZEN_ERROR_CONTACTS | 0xEF, /**< Internal system module error */ /* UNHANDLED EXCEPTION */ - CONTACTS_ERROR_INTERNAL = TIZEN_ERROR_CONTACTS | 0xFF, /**< Implementation Error, Temporary Use */ + CONTACTS_ERROR_INTERNAL = TIZEN_ERROR_CONTACTS | 0xFF, /**< Implementation Error, Temporary Use */ } contacts_error_e; + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_ERROR_H__ */ diff --git a/include/contacts_filter.h b/include/contacts_filter.h index 9db4c3b..d5055ef 100644 --- a/include/contacts_filter.h +++ b/include/contacts_filter.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_FILTER_H__ #define __TIZEN_SOCIAL_CONTACTS_FILTER_H__ @@ -25,256 +27,217 @@ extern "C" { #endif + /** * @file contacts_filter.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_FILTER_MODULE Filter - * * @brief The contacts Filter API provides the set of definitions and interfaces that enable application developers to make filters to set query. - * * @section CAPI_SOCIAL_CONTACTS_SVC_CONTACTS_FILTER_HEADER Required Header - * \#include - * + * \#include *
* @{ */ + /** * @brief Enumeration for Contacts match string flags. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_MATCH_EXACTLY, /**< Full string, case-sensitive */ - CONTACTS_MATCH_FULLSTRING, /**< Full string, case-insensitive */ - CONTACTS_MATCH_CONTAINS, /**< Sub string, case-insensitive */ - CONTACTS_MATCH_STARTSWITH, /**< Start with, case-insensitive */ - CONTACTS_MATCH_ENDSWITH, /**< End with, case-insensitive */ - CONTACTS_MATCH_EXISTS /**< IS NOT NULL */ + CONTACTS_MATCH_EXACTLY, /**< Full string, case-sensitive */ + CONTACTS_MATCH_FULLSTRING, /**< Full string, case-insensitive */ + CONTACTS_MATCH_CONTAINS, /**< Sub string, case-insensitive */ + CONTACTS_MATCH_STARTSWITH, /**< Start with, case-insensitive */ + CONTACTS_MATCH_ENDSWITH, /**< End with, case-insensitive */ + CONTACTS_MATCH_EXISTS /**< IS NOT NULL */ } contacts_match_str_flag_e; + /** * @brief Enumeration for Contacts match int flags. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_MATCH_EQUAL, /**< '=' */ - CONTACTS_MATCH_GREATER_THAN, /**< '>' */ - CONTACTS_MATCH_GREATER_THAN_OR_EQUAL, /**< '>=' */ - CONTACTS_MATCH_LESS_THAN, /**< '<' */ - CONTACTS_MATCH_LESS_THAN_OR_EQUAL, /**< '<=' */ - CONTACTS_MATCH_NOT_EQUAL, /**< '<>', this flag can yield poor performance */ - CONTACTS_MATCH_NONE, /**< IS NULL */ + CONTACTS_MATCH_EQUAL, /**< '=' */ + CONTACTS_MATCH_GREATER_THAN, /**< '>' */ + CONTACTS_MATCH_GREATER_THAN_OR_EQUAL, /**< '>=' */ + CONTACTS_MATCH_LESS_THAN, /**< '<' */ + CONTACTS_MATCH_LESS_THAN_OR_EQUAL, /**< '<=' */ + CONTACTS_MATCH_NOT_EQUAL, /**< '<>', this flag can yield poor performance */ + CONTACTS_MATCH_NONE, /**< IS NULL */ } contacts_match_int_flag_e; + /** * @brief Enumeration for Contacts filter operators. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_FILTER_OPERATOR_AND, /**< AND */ - CONTACTS_FILTER_OPERATOR_OR /**< OR */ + CONTACTS_FILTER_OPERATOR_AND, /**< AND */ + CONTACTS_FILTER_OPERATOR_OR /**< OR */ } contacts_filter_operator_e; /** * @brief Creates a filter. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You must release @a filter using contacts_filter_destroy(). - * - * @param[in] view_uri The view URI of a filter - * @param[out] filter The filter handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * - * @pre contacts_connect() should be called to initialize - * + * @param[in] view_uri The view URI of a filter + * @param[out] filter The filter handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @pre contacts_connect() should be called to initialize * @see contacts_filter_destroy() */ int contacts_filter_create(const char *view_uri, contacts_filter_h *filter); + /** * @brief Destroys a filter. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] filter The filter handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @param[in] filter The filter handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * @see contacts_filter_create() */ int contacts_filter_destroy(contacts_filter_h filter); + /** * @brief Adds a condition for a string type property. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] filter The filter handle - * @param[in] property_id The property ID to add a condition - * @param[in] match The match flag - * @param[in] match_value The match value - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The filter handle + * @param[in] property_id The property ID to add a condition + * @param[in] match The match flag + * @param[in] match_value The match value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_filter_add_operator() */ int contacts_filter_add_str(contacts_filter_h filter, unsigned int property_id, contacts_match_str_flag_e match, const char *match_value); + /** * @brief Adds a condition for an integer type property. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] filter The filter handle - * @param[in] property_id The property ID to add a condition - * @param[in] match The match flag - * @param[in] match_value The match value - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The filter handle + * @param[in] property_id The property ID to add a condition + * @param[in] match The match flag + * @param[in] match_value The match value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_filter_add_operator() */ int contacts_filter_add_int(contacts_filter_h filter, unsigned int property_id, contacts_match_int_flag_e match, int match_value); + /** * @brief Adds a condition for a long int type property. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] filter The filter handle - * @param[in] property_id The property ID to add a condition - * @param[in] match The match flag - * @param[in] match_value The match value - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The filter handle + * @param[in] property_id The property ID to add a condition + * @param[in] match The match flag + * @param[in] match_value The match value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_filter_add_operator() */ int contacts_filter_add_lli(contacts_filter_h filter, unsigned int property_id, contacts_match_int_flag_e match, long long int match_value); + /** * @brief Adds a condition for a double type property. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] filter The filter handle - * @param[in] property_id The property ID to add a condition - * @param[in] match The match flag - * @param[in] match_value The match value - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The filter handle + * @param[in] property_id The property ID to add a condition + * @param[in] match The match flag + * @param[in] match_value The match value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_filter_add_operator() */ int contacts_filter_add_double(contacts_filter_h filter, unsigned int property_id, contacts_match_int_flag_e match, double match_value); + /** * @brief Adds a condition for a boolean type property. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] filter The filter handle - * @param[in] property_id The property ID to add a condition - * @param[in] match_value The match value - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The filter handle + * @param[in] property_id The property ID to add a condition + * @param[in] match_value The match value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_filter_add_operator() */ int contacts_filter_add_bool(contacts_filter_h filter, unsigned int property_id, bool match_value); + /** * @brief Adds an operator between conditions. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] filter The filter handle - * @param[in] operator_type The operator type - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @param[in] filter The filter handle + * @param[in] operator_type The operator type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * @see contacts_filter_add_str() * @see contacts_filter_add_int() * @see contacts_filter_add_bool() */ int contacts_filter_add_operator(contacts_filter_h filter, contacts_filter_operator_e operator_type); + /** * @brief Adds a filter to a given filter. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] parent_filter The parent filter handle - * @param[in] child_filter The child filter handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @param[in] parent_filter The parent filter handle + * @param[in] child_filter The child filter handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * * @see contacts_filter_add_operator() */ int contacts_filter_add_filter(contacts_filter_h parent_filter, contacts_filter_h child_filter); + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_FILTER_H__ */ diff --git a/include/contacts_group.h b/include/contacts_group.h index 2f2ccde..a8c246b 100644 --- a/include/contacts_group.h +++ b/include/contacts_group.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_GROUP_H__ #define __TIZEN_SOCIAL_CONTACTS_GROUP_H__ @@ -25,101 +27,85 @@ extern "C" { #endif + /** * @file contacts_group.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_GROUP_MODULE Group - * * @brief The contacts group API provides the set of definitions and interfaces that enable application developers to add/remove contact as group member. - * * @section CAPI_SOCIAL_CONTACTS_SVC_GROUP_MODULE_HEADER Required Header - * \#include - * + * \#include *
* @{ */ + /** * @brief Adds a contact and a group relationship to the contacts database. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] group_id The group ID - * @param[in] contact_id The contact ID - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[in] group_id The group ID + * @param[in] contact_id The contact ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_group_remove_contact() */ int contacts_group_add_contact(int group_id, int contact_id); + /** * @brief Removes a contact and a group relationship from the contacts database. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] group_id The group ID - * @param[in] contact_id The contact ID - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[in] group_id The group ID + * @param[in] contact_id The contact ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() * @see contacts_group_add_contact() */ int contacts_group_remove_contact(int group_id, int contact_id); + /** * @brief Sets a group between the previous group and the next group. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] group_id The group ID to move - * @param[in] previous_group_id The previous group ID - * @param[in] next_group_id The back group ID - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] group_id The group ID to move + * @param[in] previous_group_id The previous group ID + * @param[in] next_group_id The back group ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_group_set_group_order(int group_id, int previous_group_id, int next_group_id); @@ -128,9 +114,11 @@ int contacts_group_set_group_order(int group_id, int previous_group_id, int next * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_GROUP_H__ */ diff --git a/include/contacts_list.h b/include/contacts_list.h index b210990..4f6aa49 100644 --- a/include/contacts_list.h +++ b/include/contacts_list.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_LIST_H__ #define __TIZEN_SOCIAL_CONTACTS_LIST_H__ @@ -25,19 +27,18 @@ extern "C" { #endif + /** * @file contacts_list.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_LIST_MODULE List - * * @brief The contacts record API provides the set of definitions and interfaces that enable application developers to get/set records list data. - * * @section CAPI_SOCIAL_CONTACTS_SVC_LIST_MODULE_HEADER Required Header - * \#include - * + * \#include *
* @{ */ @@ -45,204 +46,163 @@ extern "C" /** * @brief Creates a contacts list. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You must release @a contacts_list using contacts_list_destroy(). - * - * @param[out] contacts_list The contacts list handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @param[out] contacts_list The contacts list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * @see contacts_list_destroy() */ int contacts_list_create(contacts_list_h *contacts_list); + /** * @brief Destroys a contacts list and releases its all resources. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] contacts_list The contacts list handle - * @param[in] delete_child Set @c true to destroy child records automatically, - * otherwise set @c false to not destroy child records automatically - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @param[in] contacts_list The contacts list handle + * @param[in] delete_child Set @c true to destroy child records automatically, + * otherwise set @c false to not destroy child records automatically + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * * @see contacts_list_create() */ int contacts_list_destroy(contacts_list_h contacts_list, bool delete_child); + /** * @brief Retrieves the number of contact entities from a contacts list. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] contacts_list The contacts list handle - * @param[out] count The count of contact entity - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @param[in] contacts_list The contacts list handle + * @param[out] count The count of contact entity + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * @see contacts_list_add() */ int contacts_list_get_count(contacts_list_h contacts_list, int *count); + /** * @brief Adds a record to a contacts list. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks Same kind of record can be added. - * - * @param[in] contacts_list The contacts list handle - * @param[in] record The record handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @param[in] contacts_list The contacts list handle + * @param[in] record The record handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * @see contacts_list_remove() */ int contacts_list_add(contacts_list_h contacts_list, contacts_record_h record); + /** * @brief Removes a record from the contacts list. - * - * @details If the record is current record, then current record is changed the next record.\n + * @details If the record is current record, then current record is changed the next record. \n * If the record is the last record, then current record will be @c NULL. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] contacts_list The contacts list handle - * @param[in] record The record handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * + * @param[in] contacts_list The contacts list handle + * @param[in] record The record handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist * @see contacts_list_add() */ int contacts_list_remove(contacts_list_h contacts_list, contacts_record_h record); + /** * @brief Retrieves a record from the contacts list. - * * @details The default current record is the first record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You MUST NOT destroy the @a record. * It is destroyed automatically when the @a contacts_list is destroyed. - * - * @param[in] contacts_list The contacts list handle - * @param[out] record The record handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @param[in] contacts_list The contacts list handle + * @param[out] record The record handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist */ int contacts_list_get_current_record_p(contacts_list_h contacts_list, contacts_record_h *record); + /** * @brief Moves a contacts list to the previous position. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] contacts_list The contacts list handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * + * @param[in] contacts_list The contacts list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist * @see contacts_list_next() */ int contacts_list_prev(contacts_list_h contacts_list); + /** * @brief Moves a contacts list to the next position. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] contacts_list The contacts list handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * + * @param[in] contacts_list The contacts list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist * @see contacts_list_prev() */ int contacts_list_next(contacts_list_h contacts_list); + /** * @brief Moves a contacts list to the first position. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] contacts_list The contacts list handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * + * @param[in] contacts_list The contacts list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist * @see contacts_list_last() */ int contacts_list_first(contacts_list_h contacts_list); + /** * @brief Moves a contacts list to the last position. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] contacts_list The contacts list handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * + * @param[in] contacts_list The contacts list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist * @see contacts_list_first() */ int contacts_list_last(contacts_list_h contacts_list); + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_LIST_H__ */ diff --git a/include/contacts_person.h b/include/contacts_person.h index a9db6bd..303cce1 100644 --- a/include/contacts_person.h +++ b/include/contacts_person.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_PERSON_H__ #define __TIZEN_SOCIAL_CONTACTS_PERSON_H__ @@ -25,252 +27,211 @@ extern "C" { #endif + /** * @file contacts_person.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_PERSON_MODULE Person - * * @brief The contacts person API provides the set of definitions and interfaces that enable application developers to link/unlink person and contact. - * * @section CAPI_SOCIAL_CONTACTS_SVC_PERSON_MODULE_HEADER Required Header - * \#include - * + * \#include *
* @{ */ + /** * @brief Links a person to another person. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] base_person_id The base person ID - * @param[in] person_id The person ID to link to - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] base_person_id The base person ID + * @param[in] person_id The person ID to link to + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_person_link_person(int base_person_id, int person_id); + /** * @brief Unlinks a contact from a person. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] person_id The person ID - * @param[in] contact_id The contact ID to unlink - * @param[out] unlinked_person_id The person ID generated - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] person_id The person ID + * @param[in] contact_id The contact ID to unlink + * @param[out] unlinked_person_id The person ID generated + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_person_unlink_contact(int person_id, int contact_id, int *unlinked_person_id); + /** * @brief Resets a person's usage count. - * * @details The person is no longer in the most frequently contacted person list. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] person_id The person ID - * @param[in] type The type to reset - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] person_id The person ID + * @param[in] type The type to reset + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_person_reset_usage(int person_id, contacts_usage_type_e type); + /** * @brief Sets the order of a (favorite) contact. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] person_id The person ID to move - * @param[in] previous_person_id The previous person ID - * @param[in] next_person_id The back person ID - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] person_id The person ID to move + * @param[in] previous_person_id The previous person ID + * @param[in] next_person_id The back person ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_person_set_favorite_order(int person_id, int previous_person_id, int next_person_id); + /** * @brief Enumeration for Contacts person properties. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_PERSON_PROPERTY_NAME_CONTACT, /**< Default contacts record */ - CONTACTS_PERSON_PROPERTY_NUMBER, /**< Default number record */ - CONTACTS_PERSON_PROPERTY_EMAIL, /**< Default email record */ - CONTACTS_PERSON_PROPERTY_IMAGE, /**< Default image record */ + CONTACTS_PERSON_PROPERTY_NAME_CONTACT, /**< Default contacts record */ + CONTACTS_PERSON_PROPERTY_NUMBER, /**< Default number record */ + CONTACTS_PERSON_PROPERTY_EMAIL, /**< Default email record */ + CONTACTS_PERSON_PROPERTY_IMAGE, /**< Default image record */ } contacts_person_property_e; + /** * @brief Sets a record's default property. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * * @remarks @a id can be contact_id, number_id, email_id, image_id. - * - * @param[in] property #contacts_person_property_e - * @param[in] person_id The person ID - * @param[in] id The record ID - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] property #contacts_person_property_e + * @param[in] person_id The person ID + * @param[in] id The record ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_person_set_default_property(contacts_person_property_e property, int person_id, int id); + /** * @brief Gets a default property for a record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * * @remarks @a id can be contact_id, number_id, email_id, image_id. - * - * @param[in] property #contacts_person_property_e - * @param[in] person_id The person ID - * @param[out] id The record ID of the property to be set as default - - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] property #contacts_person_property_e + * @param[in] person_id The person ID + * @param[out] id The record ID of the property to be set as default + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_person_get_default_property(contacts_person_property_e property, int person_id, int *id); + /** * @brief Gets aggregation suggestions. - * * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * @remarks You must release @a record_list using contacts_list_destroy(). * @remarks This may take a long time. if you need to use it in bulk, make sure the user experience is acceptable while running it. - * - * @param[in] person_id The person ID - * @param[in] limit The number to limit results(value 0 is used for get all records) - * @param[out] record_list The list of person records - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @param[in] person_id The person ID + * @param[in] limit The number to limit results(value 0 is used for get all records) + * @param[out] record_list The list of person records + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_person_get_aggregation_suggestions(int person_id, int limit, contacts_list_h *record_list); + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_PERSON_H__ */ diff --git a/include/contacts_phone_log.h b/include/contacts_phone_log.h index 7395fd6..125a7a0 100644 --- a/include/contacts_phone_log.h +++ b/include/contacts_phone_log.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_PHONELOG_H__ #define __TIZEN_SOCIAL_CONTACTS_PHONELOG_H__ @@ -25,31 +27,25 @@ extern "C" { #endif + /** * @file contacts_phone_log.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_PHONELOG_MODULE Phone log - * * @brief The contacts phone log API provides the set of definitions and interfaces that enable application developers to reset phone log count. - * * @section CAPI_SOCIAL_CONTACTS_SVC_PHONELOG_MODULE_HEADER Required Header - * \#include - * + * \#include * @section CAPI_SOCIAL_CONTACTS_SVC_PHONELOG_MODULE_FEATURE Related Features - * This API is related with the following features:\n - * - http://tizen.org/feature/network.telephony\n - * - * It is recommended to design feature related codes in your application for reliability.\n - * - * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n - * - * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n - * - * More details on featuring your application can be found from Feature Element. - * + * This API is related with the following features: \n + * - http://tizen.org/feature/network.telephony \n + * It is recommended to design feature related codes in your application for reliability. \n + * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application. \n + * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK. \n + * More details on featuring your application can be found from Feature Element. *
* @{ */ @@ -58,61 +54,55 @@ extern "C" /** * @brief Resets the phone log's count. * @details The number of all types in the phone log will be @c 0. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/callhistory.write - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * - * @see contacts_connect() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @see contacts_connect() */ int contacts_phone_log_reset_statistics(void); + /** * @brief Resets the phone log's count by sim slot no. - * * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/callhistory.write - * - * @param[in] sim_slot_no It is related to the SIM slot number. sim_slot_no 0 means first SIM, sim_slot_no 1 means second SIM - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_DB Database operation failure - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[in] sim_slot_no It is related to the SIM slot number. sim_slot_no 0 means first SIM, sim_slot_no 1 means second SIM + * @return @c 0 on success, + * otherwise a negative error value + * + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_DB Database operation failure + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() */ int contacts_phone_log_reset_statistics_by_sim(int sim_slot_no); + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_PHONELOG_H__ */ diff --git a/include/contacts_query.h b/include/contacts_query.h index ff8d680..6066ec8 100644 --- a/include/contacts_query.h +++ b/include/contacts_query.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_QUERY_H__ #define __TIZEN_SOCIAL_CONTACTS_QUERY_H__ @@ -25,136 +27,113 @@ extern "C" { #endif + /** * @file contacts_query.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_QUERY_MODULE Query - * * @brief The contacts Query API provides the set of definitions and interfaces that enable application developers to make query to get list. - * * @section CAPI_SOCIAL_CONTACTS_SVC_CONTACTS_QUERY_HEADER Required Header - * \#include - * + * \#include *
* @{ */ + /** * @brief Creates a query. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You must release @a query using contacts_query_destroy(). - * - * @param[in] view_uri The view URI of a query - * @param[out] query The filter handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * - * @pre contacts_connect() should be called to initialize - * + * @param[in] view_uri The view URI of a query + * @param[out] query The filter handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @pre contacts_connect() should be called to initialize * @see contacts_query_destroy() */ int contacts_query_create(const char *view_uri, contacts_query_h *query); + /** * @brief Destroys a query. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] query The query handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @param[in] query The query handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * @see contacts_query_create() */ int contacts_query_destroy(contacts_query_h query); + /** * @brief Adds property IDs for projection. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] query The query handle - * @param[in] property_id_array The property ID array - * @param[in] count The number of property IDs - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] query The query handle + * @param[in] property_id_array The property ID array + * @param[in] count The number of property IDs + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported */ int contacts_query_set_projection(contacts_query_h query, unsigned int property_id_array[], int count); + /** * @brief Sets the "distinct" option for projection. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] query The query handle - * @param[in] set Set @c true to set the distinct option for projection, - * otherwise @c false to unset the distinct option - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @param[in] query The query handle + * @param[in] set Set @c true to set the distinct option for projection, + * otherwise @c false to unset the distinct option + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter */ int contacts_query_set_distinct(contacts_query_h query, bool set); + /** * @brief Sets a filter for query. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] query The query handle - * @param[in] filter The filter handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @param[in] query The query handle + * @param[in] filter The filter handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * @see contacts_filter_create() */ int contacts_query_set_filter(contacts_query_h query, contacts_filter_h filter); + /** * @brief Sets a sort mode for query. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] query The query handle - * @param[in] property_id The property ID to sort - * @param[in] is_ascending Set @c true for ascending sort mode, - * otherwise @c false for descending sort mode - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] query The query handle + * @param[in] property_id The property ID to sort + * @param[in] is_ascending Set @c true for ascending sort mode, + * otherwise @c false for descending sort mode + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported */ int contacts_query_set_sort(contacts_query_h query, unsigned int property_id, bool is_ascending); + /** * @} */ @@ -164,5 +143,6 @@ int contacts_query_set_sort(contacts_query_h query, unsigned int property_id, bo } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_QUERY_H__ */ diff --git a/include/contacts_record.h b/include/contacts_record.h index 8038d26..9ba8571 100644 --- a/include/contacts_record.h +++ b/include/contacts_record.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_RECORD_H__ #define __TIZEN_SOCIAL_CONTACTS_RECORD_H__ @@ -25,19 +27,18 @@ extern "C" { #endif + /** * @file contacts_record.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_RECORD_MODULE Record - * * @brief The contacts record API provides the set of the definitions and interfaces that enable application developers to get/set data from/to contacts record handle. - * * @section CAPI_SOCIAL_CONTACTS_SVC_RECORD_MODULE_HEADER Required Header - * \#include - * + * \#include *
* @{ */ @@ -45,428 +46,351 @@ extern "C" /** * @brief Creates a record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You must release @a record using contacts_record_destroy(). - * - * @param[in] view_uri The view URI - * @param[out] record The record handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * - * @pre contacts_connect() should be called to initialize. - * + * @param[in] view_uri The view URI + * @param[out] record The record handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @pre contacts_connect() should be called to initialize. * @see contacts_record_destroy() */ int contacts_record_create(const char *view_uri, contacts_record_h *record); + /** * @brief Destroys a record and releases its all resources. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] delete_child Set @c true to destroy child records automatically, - * otherwise set @c false to not destroy child records automatically - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @param[in] record The record handle + * @param[in] delete_child Set @c true to destroy child records automatically, + * otherwise set @c false to not destroy child records automatically + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * @see contacts_record_create() */ int contacts_record_destroy(contacts_record_h record, bool delete_child); + /** * @brief Makes a clone of a record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You must release @a cloned_record using contacts_record_destroy(). - * - * @param[in] record The record handle - * @param[out] cloned_record The cloned record handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @param[in] record The record handle + * @param[out] cloned_record The cloned record handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter * @see contacts_record_destroy() */ int contacts_record_clone(contacts_record_h record, contacts_record_h *cloned_record); + /** * @brief Gets a string from the record handle. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You must release @a value using free(). - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[out] value The value to be returned - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[out] value The value to be returned + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_record_get_str_p() * @see contacts_record_set_str() */ int contacts_record_get_str(contacts_record_h record, unsigned int property_id, char **value); + /** * @brief Gets a string pointer from the record handle. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You MUST NOT release @a value. - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[out] value The value to be returned - * + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[out] value The value to be returned * @return @c 0 on success, * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_record_get_str() * @see contacts_record_set_str() */ int contacts_record_get_str_p(contacts_record_h record, unsigned int property_id, char **value); + /** * @brief Sets a string to a record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[in] value The value to set - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[in] value The value to set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_record_get_str() * @see contacts_record_get_str_p() */ int contacts_record_set_str(contacts_record_h record, unsigned int property_id, const char *value); + /** * @brief Gets a record's integer value. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[out] value The value to be returned - * + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[out] value The value to be returned * @return @c 0 on success, * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_record_set_int() */ int contacts_record_get_int(contacts_record_h record, unsigned int property_id, int *value); + /** * @brief Sets an integer value to a record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[in] value The value to set - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[in] value The value to set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_record_get_int() */ int contacts_record_set_int(contacts_record_h record, unsigned int property_id, int value); + /** * @brief Gets a record's long integer value. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[out] value The value to be returned - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[out] value The value to be returned + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * * @see contacts_record_set_lli() */ int contacts_record_get_lli(contacts_record_h record, unsigned int property_id, long long int *value); + /** * @brief Sets a long long integer value to a record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[in] value The value to set - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[in] value The value to set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * * @see contacts_record_get_lli() */ int contacts_record_set_lli(contacts_record_h record, unsigned int property_id, long long int value); + /** * @brief Gets a record's boolean value. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[out] value The value to be returned - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[out] value The value to be returned + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * * @see contacts_record_set_bool() */ int contacts_record_get_bool(contacts_record_h record, unsigned int property_id, bool *value); + /** * @brief Sets a boolean value to a record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[in] value The value to set - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[in] value The value to set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * * @see contacts_record_get_bool() */ int contacts_record_set_bool(contacts_record_h record, unsigned int property_id, bool value); + /** * @brief Gets a record's double value. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[out] value The value to be returned - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[out] value The value to be returned + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * * @see contacts_record_set_double() */ int contacts_record_get_double(contacts_record_h record, unsigned int property_id, double *value); + /** * @brief Sets a double value to a record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[in] value The value to set - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[in] value The value to set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_record_get_double() */ int contacts_record_set_double(contacts_record_h record, unsigned int property_id, double value); + /** * @brief Adds a child record to the parent record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The parent record handle - * @param[in] property_id The property ID - * @param[in] child_record The child record handle to be added to parent record handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] record The parent record handle + * @param[in] property_id The property ID + * @param[in] child_record The child record handle to be added to parent record handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * * @see contacts_record_remove_child_record() */ int contacts_record_add_child_record(contacts_record_h record, unsigned int property_id, contacts_record_h child_record); + /** * @brief Removes a child record from the parent record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The parent record handle - * @param[in] property_id The property ID - * @param[in] child_record The child record handle to be removed from parent record handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] record The parent record handle + * @param[in] property_id The property ID + * @param[in] child_record The child record handle to be removed from parent record handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_record_add_child_record() */ int contacts_record_remove_child_record(contacts_record_h record, unsigned int property_id, contacts_record_h child_record); + /** * @brief Gets the number of child records of a parent record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The parent record handle - * @param[in] property_id The property ID - * @param[out] count The child record count - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] record The parent record handle + * @param[in] property_id The property ID + * @param[out] count The child record count + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_record_add_child_record() * @see contacts_record_remove_child_record() */ int contacts_record_get_child_record_count(contacts_record_h record, unsigned int property_id, int *count); + /** * @brief Gets a child record handle pointer from the parent record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You MUST NOT release @a child_record. It is released when the parent record is destroyed. - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[in] index The index of child record - * @param[out] child_record The child record handle pointer - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[in] index The index of child record + * @param[out] child_record The child record handle pointer + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * @see contacts_record_add_child_record() * @see contacts_record_remove_child_record() * @see contacts_record_get_child_record_count() */ int contacts_record_get_child_record_at_p(contacts_record_h record, unsigned int property_id, int index, contacts_record_h *child_record); + /** * @brief Clones a child record list of the given parent record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks You must release @a cloned_list using contacts_list_destroy(). - * - * @param[in] record The record handle - * @param[in] property_id The property ID - * @param[out] cloned_list The cloned list handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] record The record handle + * @param[in] property_id The property ID + * @param[out] cloned_list The cloned list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported * * @see contacts_list_destroy() */ int contacts_record_clone_child_record_list(contacts_record_h record, unsigned int property_id, contacts_list_h *cloned_list); + /** * @brief Gets URI string from a record. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[out] view_uri The URI of record - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported + * @param[in] record The record handle + * @param[out] view_uri The URI of record + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NOT_SUPPORTED Not supported */ int contacts_record_get_uri_p(contacts_record_h record, const char **view_uri); + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_RECORD_H__ */ diff --git a/include/contacts_service.h b/include/contacts_service.h index b54b0b1..7cc9274 100644 --- a/include/contacts_service.h +++ b/include/contacts_service.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_SERVICE_H__ #define __TIZEN_SOCIAL_CONTACTS_SERVICE_H__ @@ -25,103 +27,86 @@ extern "C" { #endif + /** * @file contacts_service.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_COMMON_MODULE Common - * * @brief The contacts common API provides the set of definitions and interfaces to initialize and deinitialize. - * * @section CAPI_SOCIAL_CONTACTS_SVC_COMMON_MODULE_HEADER Required Header - * \#include - * + * \#include *
* @{ */ + /** * @brief Connects to the contacts service. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks Connection opening is necessary to access the contacts server such as fetching, inserting, or updating records.\n * The execution of contacts_connect() and contacts_disconnect() could slow down your application. So it is not recommended to call them frequently. - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_SYSTEM System error - * @retval #CONTACTS_ERROR_INTERNAL Internal error - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_SYSTEM System error + * @retval #CONTACTS_ERROR_INTERNAL Internal error * @see contacts_disconnect() */ int contacts_connect(void); + /** * @brief Disconnects from the contacts service. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks If there is no opened connection, this function returns #CONTACTS_ERROR_DB. - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_SYSTEM System error - * @retval #CONTACTS_ERROR_DB Database operation failure - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_SYSTEM System error + * @retval #CONTACTS_ERROR_DB Database operation failure * @see contacts_connect() */ int contacts_disconnect(void); + /** * @brief Connects to the contacts service with a connection on another thread. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks Opening connection is necessary to access the contact server and to perform operations such as fetching, inserting, or updating records.\n * On multiple thread environment with contacts_connect(), request can be failed in one thread, while another request is working by the connection in the other thread. * To prevent request fail, contacts_connect_on_thread() is recommended. Then new connection is set for the thread. - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_SYSTEM System error - * @retval #CONTACTS_ERROR_INTERNAL Internal error - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * - * @see contacts_disconnect_on_thread() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_SYSTEM System error + * @retval #CONTACTS_ERROR_INTERNAL Internal error + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. + * @see contacts_disconnect_on_thread() */ int contacts_connect_on_thread(void); + /** * @brief Disconnects from the contacts service. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @remarks If there is no opened connection, this function returns #CONTACTS_ERROR_DB. - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_SYSTEM System error - * @retval #CONTACTS_ERROR_DB Database operation failure - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_SYSTEM System error + * @retval #CONTACTS_ERROR_DB Database operation failure * @see contacts_connect_on_thread() */ int contacts_disconnect_on_thread(void); @@ -129,51 +114,45 @@ int contacts_disconnect_on_thread(void); /** * @brief Definition for contacts_connect_with_flags(). If it is called the API with this flag, then retry to call contacts_connect() for several times. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @see contacts_connect_with_flags() */ #define CONTACTS_CONNECT_FLAG_RETRY 0x00000001 + /** * @brief Definition for default flag of contacts_connect_with_flags(). - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * * @see contacts_connect_with_flags() */ #define CONTACTS_CONNECT_FLAG_NONE 0 + /** * @brief Connects to the contacts service. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] flags connection flag - * + * @param[in] flags Connection flag * @remarks Connection opening is necessary to access the contacts server such as fetching, inserting, or updating records.\n * Before contacts-service daemon is ready, if you call contacts_connect(), it will fail. * To prevent it, if you call this API with @ref CONTACTS_CONNECT_FLAG_RETRY flags, it will retry several time.\n * To close the connection, contacts_disconnect() should be called. - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_IPC IPC error - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_SYSTEM System error - * @retval #CONTACTS_ERROR_INTERNAL Internal error - * - * @see contacts_disconnect() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_IPC IPC error + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_SYSTEM System error + * @retval #CONTACTS_ERROR_INTERNAL Internal error + * @see contacts_disconnect() */ int contacts_connect_with_flags(unsigned int flags); + /** * @} */ + #ifdef __cplusplus } #endif diff --git a/include/contacts_setting.h b/include/contacts_setting.h index 9c6f68c..895cc4a 100644 --- a/include/contacts_setting.h +++ b/include/contacts_setting.h @@ -25,80 +25,67 @@ extern "C" { #endif + /** * @file contacts_setting.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_SETTING_MODULE Setting - * * @brief The contacts setting API provides the set of definitions and interfaces that enable application developers to set up contacts features. - * * @section CAPI_SOCIAL_CONTACTS_SVC_SETTING_MODULE_HEADER Required Header - * \#include - * + * \#include *
* @{ */ + /** * @brief Enumeration for name display order. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_NAME_DISPLAY_ORDER_FIRSTLAST, /**< First name comes at the first */ - CONTACTS_NAME_DISPLAY_ORDER_LASTFIRST /**< First name comes at the last */ + CONTACTS_NAME_DISPLAY_ORDER_FIRSTLAST, /**< First name comes at the first */ + CONTACTS_NAME_DISPLAY_ORDER_LASTFIRST /**< First name comes at the last */ } contacts_name_display_order_e; /** * @brief Gets the contacts name display order. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * - * @param[out] name_display_order The name display order - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_IPC Unknown IPC error - * @retval #CONTACTS_ERROR_SYSTEM Internal system module error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[out] name_display_order The name display order + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_IPC Unknown IPC error + * @retval #CONTACTS_ERROR_SYSTEM Internal system module error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() */ int contacts_setting_get_name_display_order(contacts_name_display_order_e *name_display_order); + /** * @brief Sets the contacts name display order. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * * @param[in] name_display_order The name display order - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_IPC Unknown IPC error - * @retval #CONTACTS_ERROR_SYSTEM Internal system module error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_setting_name_display_order_changed_cb() callback will be called upon success. - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_IPC Unknown IPC error + * @retval #CONTACTS_ERROR_SYSTEM Internal system module error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_setting_name_display_order_changed_cb() callback will be called upon success. * @see contacts_connect() */ int contacts_setting_set_name_display_order(contacts_name_display_order_e name_display_order); @@ -106,77 +93,61 @@ int contacts_setting_set_name_display_order(contacts_name_display_order_e name_d /** * @brief Enumeration for name sorting order. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * */ typedef enum { - CONTACTS_NAME_SORTING_ORDER_FIRSTLAST, /**< Contacts are first sorted based on the first name */ - CONTACTS_NAME_SORTING_ORDER_LASTFIRST /**< Contacts are first sorted based on the last name */ + CONTACTS_NAME_SORTING_ORDER_FIRSTLAST, /**< Contacts are first sorted based on the first name */ + CONTACTS_NAME_SORTING_ORDER_LASTFIRST /**< Contacts are first sorted based on the last name */ } contacts_name_sorting_order_e; /** * @brief Gets the contacts name sorting order in which contacts are returned. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * - * @param[out] name_sorting_order The name sorting order - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_IPC Unknown IPC error - * @retval #CONTACTS_ERROR_SYSTEM Internal system module error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * + * @param[out] name_sorting_order The name sorting order + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. + * @retval #CONTACTS_ERROR_IPC Unknown IPC error + * @retval #CONTACTS_ERROR_SYSTEM Internal system module error + * @pre contacts_connect() should be called to open a connection to the contacts service. * @see contacts_connect() */ int contacts_setting_get_name_sorting_order(contacts_name_sorting_order_e *name_sorting_order); + /** * @brief Sets the contacts name sorting order in which contacts are returned. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * - * @param[in] name_sorting_order The name sorting order - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_IPC Unknown IPC error - * @retval #CONTACTS_ERROR_SYSTEM Internal system module error - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_setting_name_sorting_order_changed_cb() callback will be called upon success. - * + * @param[in] name_sorting_order The name sorting order + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_IPC Unknown IPC error + * @retval #CONTACTS_ERROR_SYSTEM Internal system module error + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_setting_name_sorting_order_changed_cb() callback will be called upon success. * @see contacts_connect() */ int contacts_setting_set_name_sorting_order(contacts_name_sorting_order_e name_sorting_order); /** * @brief Called when a designated view changes. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] name_display_order The name display order setting value - * @param[in] user_data The user data passed from the callback registration function - * + * @param[in] name_display_order The name display order setting value + * @param[in] user_data The user data passed from the callback registration function * @pre The callback must be registered using contacts_setting_add_name_display_order_changed_cb(). - * contacts_setting_set_name_display_order() must be called to invoke this callback. - * + * contacts_setting_set_name_display_order() must be called to invoke this callback. * @see contacts_setting_add_name_display_order_changed_cb() * @see contacts_setting_remove_name_display_order_changed_cb() */ @@ -185,64 +156,50 @@ typedef void (*contacts_setting_name_display_order_changed_cb)(contacts_name_dis /** * @brief Registers a callback function. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_IPC Unknown IPC error - * @retval #CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_setting_name_display_order_changed_cb() will be called under certain conditions, after calling contacts_setting_set_name_display_order(). - * + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_IPC Unknown IPC error + * @retval #CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_setting_name_display_order_changed_cb() will be called under certain conditions, after calling contacts_setting_set_name_display_order(). * @see contacts_connect() * @see contacts_setting_remove_name_display_order_changed_cb() */ - int contacts_setting_add_name_display_order_changed_cb(contacts_setting_name_display_order_changed_cb callback, void *user_data); + /** * @brief Unregisters a callback function. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use - * + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use * @pre contacts_connect() should be called to open a connection to the contacts service. - * * @see contacts_connect() * @see contacts_setting_add_name_display_order_changed_cb() */ - int contacts_setting_remove_name_display_order_changed_cb(contacts_setting_name_display_order_changed_cb callback, void *user_data); + /** * @brief Called when a designated view changes. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * @param[in] name_sorting_order The name sorting order setting value - * @param[in] user_data The user data passed from the callback registration function - * + * @param[in] name_sorting_order The name sorting order setting value + * @param[in] user_data The user data passed from the callback registration function * @pre The callback must be registered using contacts_setting_add_name_sorting_order_changed_cb(). - * contacts_setting_set_name_sorting_order() must be called to invoke this callback. - * + * contacts_setting_set_name_sorting_order() must be called to invoke this callback. * @see contacts_setting_add_name_sorting_order_changed_cb() * @see contacts_setting_remove_name_sorting_order_changed_cb() */ @@ -251,61 +208,52 @@ typedef void (*contacts_setting_name_sorting_order_changed_cb)(contacts_name_sor /** * @brief Registers a callback function. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_IPC Unknown IPC error - * @retval #CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * - * @pre contacts_connect() should be called to open a connection to the contacts service. - * @post contacts_setting_name_sorting_order_changed_cb() will be called under certain conditions, after calling contacts_setting_set_name_sorting_order(). - * + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_IPC Unknown IPC error + * @retval #CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @pre contacts_connect() should be called to open a connection to the contacts service. + * @post contacts_setting_name_sorting_order_changed_cb() will be called under certain conditions, after calling contacts_setting_set_name_sorting_order(). * @see contacts_connect() * @see contacts_setting_remove_name_sorting_order_changed_cb() */ - int contacts_setting_add_name_sorting_order_changed_cb(contacts_setting_name_sorting_order_changed_cb callback, void *user_data); + /** * @brief Unregisters a callback function. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * @param[in] callback The callback function to register - * @param[in] user_data The user data to be passed to the callback function - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use - * + * @param[in] callback The callback function to register + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use * @pre contacts_connect() should be called to open a connection to the contacts service. - * * @see contacts_connect() * @see contacts_setting_add_name_sorting_order_changed_cb() */ - int contacts_setting_remove_name_sorting_order_changed_cb(contacts_setting_name_sorting_order_changed_cb callback, void *user_data); + /** * @} */ - + + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_SETTING_H__ */ diff --git a/include/contacts_types.h b/include/contacts_types.h index 590b686..e0556bc 100644 --- a/include/contacts_types.h +++ b/include/contacts_types.h @@ -17,14 +17,17 @@ * */ + #ifndef __TIZEN_SOCIAL_CONTACTS_TYPES_H__ #define __TIZEN_SOCIAL_CONTACTS_TYPES_H__ + #ifdef __cplusplus extern "C" { #endif + #define _CONTACTS_BEGIN_VIEW() \ typedef struct { \ const char* const _uri; @@ -35,15 +38,18 @@ extern "C" #define _CONTACTS_PROPERTY_DOUBLE(property_id_name) unsigned int property_id_name; #define _CONTACTS_PROPERTY_LLI(property_id_name) unsigned int property_id_name; + #define _CONTACTS_PROPERTY_CHILD_SINGLE(property_id_name) unsigned int property_id_name; #define _CONTACTS_PROPERTY_CHILD_MULTIPLE(property_id_name) unsigned int property_id_name; + #define _CONTACTS_PROPERTY_FILTER_INT(property_id_name) unsigned int property_id_name; #define _CONTACTS_PROPERTY_FILTER_STR(property_id_name) unsigned int property_id_name; #define _CONTACTS_PROPERTY_FILTER_BOOL(property_id_name) unsigned int property_id_name; #define _CONTACTS_PROPERTY_FILTER_DOUBLE(property_id_name) unsigned int property_id_name; #define _CONTACTS_PROPERTY_FILTER_LLI(property_id_name) unsigned int property_id_name; + #define _CONTACTS_PROPERTY_PROJECTION_INT(property_id_name) unsigned int property_id_name; #define _CONTACTS_PROPERTY_PROJECTION_STR(property_id_name) unsigned int property_id_name; #define _CONTACTS_PROPERTY_PROJECTION_BOOL(property_id_name) unsigned int property_id_name; @@ -52,30 +58,34 @@ extern "C" #define _CONTACTS_END_VIEW(name) } name##_property_ids; \ extern __attribute__ ((visibility("default"))) const name##_property_ids name; + #define _CONTACTS_END_READ_ONLY_VIEW(name) _CONTACTS_END_VIEW(name) + #define _CONTACTS_HANDLE(A) typedef struct __##A{} * A; + _CONTACTS_HANDLE(contacts_record_h) _CONTACTS_HANDLE(contacts_filter_h) _CONTACTS_HANDLE(contacts_list_h) _CONTACTS_HANDLE(contacts_query_h) _CONTACTS_HANDLE(contacts_h) + /** * @file contacts_types.h */ + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_RECORD_MODULE * @{ */ + /** * @brief Enumeration for contacts data type. - * * @since_tizen 3.0 - * */ typedef enum { CONTACTS_DATA_TYPE_NAME = 1, @@ -95,64 +105,61 @@ typedef enum { CONTACTS_DATA_TYPE_EXTENSION = 100 } contacts_data_type_e; + /** * @brief Enumeration for contacts number type. - * * @details The number can be made with a set of values by specifying one or more values. - * \n Example : CTS_NUM_TYPE_HOME|CTS_NUM_TYPE_VOICE - * \n Exceptionally, CTS_NUM_TYPE_CUSTOM is exclusive. - * + * Example : CTS_NUM_TYPE_HOME|CTS_NUM_TYPE_VOICE + * Exceptionally, CTS_NUM_TYPE_CUSTOM is exclusive. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_NUMBER_TYPE_OTHER, /**< Other number type */ - CONTACTS_NUMBER_TYPE_CUSTOM = 1<<0, /**< Custom number type */ - CONTACTS_NUMBER_TYPE_HOME = 1<<1, /**< A telephone number associated with a residence */ - CONTACTS_NUMBER_TYPE_WORK = 1<<2, /**< A telephone number associated with a place of work */ - CONTACTS_NUMBER_TYPE_VOICE = 1<<3, /**< A voice telephone number */ - CONTACTS_NUMBER_TYPE_FAX = 1<<4, /**< A facsimile telephone number */ - CONTACTS_NUMBER_TYPE_MSG = 1<<5, /**< The telephone number has voice messaging support */ - CONTACTS_NUMBER_TYPE_CELL = 1<<6, /**< A cellular telephone number */ - CONTACTS_NUMBER_TYPE_PAGER = 1<<7, /**< A paging device telephone number */ - CONTACTS_NUMBER_TYPE_BBS = 1<<8, /**< A bulletin board system telephone number */ - CONTACTS_NUMBER_TYPE_MODEM = 1<<9, /**< A MODEM connected telephone number */ - CONTACTS_NUMBER_TYPE_CAR = 1<<10, /**< A car-phone telephone number */ - CONTACTS_NUMBER_TYPE_ISDN = 1<<11, /**< An ISDN service telephone number */ - CONTACTS_NUMBER_TYPE_VIDEO = 1<<12, /**< A video conferencing telephone number */ - CONTACTS_NUMBER_TYPE_PCS = 1<<13, /**< A personal communication services telephone number */ - CONTACTS_NUMBER_TYPE_COMPANY_MAIN = 1<<14, /**< A company main number */ - CONTACTS_NUMBER_TYPE_RADIO = 1<<15, /**< A radio phone number */ - CONTACTS_NUMBER_TYPE_MAIN = 1<<29, /**< An additional type for main */ - CONTACTS_NUMBER_TYPE_ASSISTANT = 1<<30, /**< An additional type for assistant */ + CONTACTS_NUMBER_TYPE_OTHER, /**< Other number type */ + CONTACTS_NUMBER_TYPE_CUSTOM = 1<<0, /**< Custom number type */ + CONTACTS_NUMBER_TYPE_HOME = 1<<1, /**< A telephone number associated with a residence */ + CONTACTS_NUMBER_TYPE_WORK = 1<<2, /**< A telephone number associated with a place of work */ + CONTACTS_NUMBER_TYPE_VOICE = 1<<3, /**< A voice telephone number */ + CONTACTS_NUMBER_TYPE_FAX = 1<<4, /**< A facsimile telephone number */ + CONTACTS_NUMBER_TYPE_MSG = 1<<5, /**< The telephone number has voice messaging support */ + CONTACTS_NUMBER_TYPE_CELL = 1<<6, /**< A cellular telephone number */ + CONTACTS_NUMBER_TYPE_PAGER = 1<<7, /**< A paging device telephone number */ + CONTACTS_NUMBER_TYPE_BBS = 1<<8, /**< A bulletin board system telephone number */ + CONTACTS_NUMBER_TYPE_MODEM = 1<<9, /**< A MODEM connected telephone number */ + CONTACTS_NUMBER_TYPE_CAR = 1<<10, /**< A car-phone telephone number */ + CONTACTS_NUMBER_TYPE_ISDN = 1<<11, /**< An ISDN service telephone number */ + CONTACTS_NUMBER_TYPE_VIDEO = 1<<12, /**< A video conferencing telephone number */ + CONTACTS_NUMBER_TYPE_PCS = 1<<13, /**< A personal communication services telephone number */ + CONTACTS_NUMBER_TYPE_COMPANY_MAIN = 1<<14, /**< A company main number */ + CONTACTS_NUMBER_TYPE_RADIO = 1<<15, /**< A radio phone number */ + CONTACTS_NUMBER_TYPE_MAIN = 1<<29, /**< An additional type for main */ + CONTACTS_NUMBER_TYPE_ASSISTANT = 1<<30, /**< An additional type for assistant */ } contacts_number_type_e; + /** * @brief Enumeration for Contact email type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_EMAIL_TYPE_OTHER, /**< Other email type */ - CONTACTS_EMAIL_TYPE_CUSTOM = 1<<0, /**< Custom email type */ - CONTACTS_EMAIL_TYPE_HOME = 1<<1, /**< An email address associated with a residence */ - CONTACTS_EMAIL_TYPE_WORK = 1<<2, /**< An email address associated with a place of work */ - CONTACTS_EMAIL_TYPE_MOBILE = 1<<3, /**< A mobile email address */ + CONTACTS_EMAIL_TYPE_OTHER, /**< Other email type */ + CONTACTS_EMAIL_TYPE_CUSTOM = 1<<0, /**< Custom email type */ + CONTACTS_EMAIL_TYPE_HOME = 1<<1, /**< An email address associated with a residence */ + CONTACTS_EMAIL_TYPE_WORK = 1<<2, /**< An email address associated with a place of work */ + CONTACTS_EMAIL_TYPE_MOBILE = 1<<3, /**< A mobile email address */ } contacts_email_type_e; + /** * @brief Enumeration for Contact company type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_COMPANY_TYPE_OTHER, /**< Other company type */ - CONTACTS_COMPANY_TYPE_CUSTOM = 1<<0, /**< Custom company type */ - CONTACTS_COMPANY_TYPE_WORK = 1<<1, /**< Work company type */ + CONTACTS_COMPANY_TYPE_OTHER, /**< Other company type */ + CONTACTS_COMPANY_TYPE_CUSTOM = 1<<0, /**< Custom company type */ + CONTACTS_COMPANY_TYPE_WORK = 1<<1, /**< Work company type */ } contacts_company_type_e; + /** * @brief Enumeration for Contact address type. * @@ -160,233 +167,224 @@ typedef enum { * */ typedef enum { - CONTACTS_ADDRESS_TYPE_OTHER, /**< Other address type */ - CONTACTS_ADDRESS_TYPE_CUSTOM = 1<<0, /**< A delivery address for a residence */ - CONTACTS_ADDRESS_TYPE_HOME = 1<<1, /**< A delivery address for a residence */ - CONTACTS_ADDRESS_TYPE_WORK = 1<<2, /**< A delivery address for a place of work */ - CONTACTS_ADDRESS_TYPE_DOM = 1<<3, /**< A domestic delivery address */ - CONTACTS_ADDRESS_TYPE_INTL = 1<<4, /**< An international delivery address */ - CONTACTS_ADDRESS_TYPE_POSTAL = 1<<5, /**< A postal delivery address */ - CONTACTS_ADDRESS_TYPE_PARCEL = 1<<6, /**< A parcel delivery address */ + CONTACTS_ADDRESS_TYPE_OTHER, /**< Other address type */ + CONTACTS_ADDRESS_TYPE_CUSTOM = 1<<0, /**< A delivery address for a residence */ + CONTACTS_ADDRESS_TYPE_HOME = 1<<1, /**< A delivery address for a residence */ + CONTACTS_ADDRESS_TYPE_WORK = 1<<2, /**< A delivery address for a place of work */ + CONTACTS_ADDRESS_TYPE_DOM = 1<<3, /**< A domestic delivery address */ + CONTACTS_ADDRESS_TYPE_INTL = 1<<4, /**< An international delivery address */ + CONTACTS_ADDRESS_TYPE_POSTAL = 1<<5, /**< A postal delivery address */ + CONTACTS_ADDRESS_TYPE_PARCEL = 1<<6, /**< A parcel delivery address */ } contacts_address_type_e; + /** * @brief Enumeration for Contact URL type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_URL_TYPE_OTHER, /**< Other URL type*/ - CONTACTS_URL_TYPE_CUSTOM, /**< Custom URL type */ - CONTACTS_URL_TYPE_HOME, /**< Home URL type */ - CONTACTS_URL_TYPE_WORK, /**< Work URL type */ + CONTACTS_URL_TYPE_OTHER, /**< Other URL type*/ + CONTACTS_URL_TYPE_CUSTOM, /**< Custom URL type */ + CONTACTS_URL_TYPE_HOME, /**< Home URL type */ + CONTACTS_URL_TYPE_WORK, /**< Work URL type */ } contacts_url_type_e; + /** * @brief Enumeration for Contact messenger type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_MESSENGER_TYPE_OTHER, /**< Other messenger type */ - CONTACTS_MESSENGER_TYPE_CUSTOM, /**< Custom messenger type */ - CONTACTS_MESSENGER_TYPE_GOOGLE, /**< Google messenger type */ - CONTACTS_MESSENGER_TYPE_WLM, /**< Windows live messenger type */ - CONTACTS_MESSENGER_TYPE_YAHOO, /**< Yahoo messenger type */ - CONTACTS_MESSENGER_TYPE_FACEBOOK, /**< Facebook messenger type */ - CONTACTS_MESSENGER_TYPE_ICQ, /**< ICQ type */ - CONTACTS_MESSENGER_TYPE_AIM, /**< AOL instance messenger type */ - CONTACTS_MESSENGER_TYPE_QQ, /**< QQ type */ - CONTACTS_MESSENGER_TYPE_JABBER, /**< Jabber type */ - CONTACTS_MESSENGER_TYPE_SKYPE, /**< Skype type */ - CONTACTS_MESSENGER_TYPE_IRC, /**< IRC type */ + CONTACTS_MESSENGER_TYPE_OTHER, /**< Other messenger type */ + CONTACTS_MESSENGER_TYPE_CUSTOM, /**< Custom messenger type */ + CONTACTS_MESSENGER_TYPE_GOOGLE, /**< Google messenger type */ + CONTACTS_MESSENGER_TYPE_WLM, /**< Windows live messenger type */ + CONTACTS_MESSENGER_TYPE_YAHOO, /**< Yahoo messenger type */ + CONTACTS_MESSENGER_TYPE_FACEBOOK, /**< Facebook messenger type */ + CONTACTS_MESSENGER_TYPE_ICQ, /**< ICQ type */ + CONTACTS_MESSENGER_TYPE_AIM, /**< AOL instance messenger type */ + CONTACTS_MESSENGER_TYPE_QQ, /**< QQ type */ + CONTACTS_MESSENGER_TYPE_JABBER, /**< Jabber type */ + CONTACTS_MESSENGER_TYPE_SKYPE, /**< Skype type */ + CONTACTS_MESSENGER_TYPE_IRC, /**< IRC type */ } contacts_messenger_type_e; + /** * @brief Enumeration for Call history type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_PLOG_TYPE_NONE, /**< None */ - CONTACTS_PLOG_TYPE_VOICE_INCOMING = 1, /**< Incoming call */ - CONTACTS_PLOG_TYPE_VOICE_OUTGOING = 2, /**< Outgoing call */ - CONTACTS_PLOG_TYPE_VIDEO_INCOMING = 3, /**< Incoming video call */ - CONTACTS_PLOG_TYPE_VIDEO_OUTGOING = 4, /**< Outgoing video call */ - CONTACTS_PLOG_TYPE_VOICE_INCOMING_UNSEEN = 5, /**< Not confirmed missed call */ - CONTACTS_PLOG_TYPE_VOICE_INCOMING_SEEN = 6, /**< Confirmed missed call */ - CONTACTS_PLOG_TYPE_VIDEO_INCOMING_UNSEEN = 7, /**< Not confirmed missed video call */ - CONTACTS_PLOG_TYPE_VIDEO_INCOMING_SEEN = 8, /**< Confirmed missed video call */ - CONTACTS_PLOG_TYPE_VOICE_REJECT = 9, /**< Rejected call */ - CONTACTS_PLOG_TYPE_VIDEO_REJECT = 10, /**< Rejected video call */ - CONTACTS_PLOG_TYPE_VOICE_BLOCKED = 11, /**< Blocked call */ - CONTACTS_PLOG_TYPE_VIDEO_BLOCKED = 12, /**< Blocked video call */ - - CONTACTS_PLOG_TYPE_MMS_INCOMING = 101, /**< Incoming MMS */ - CONTACTS_PLOG_TYPE_MMS_OUTGOING = 102, /**< Outgoing MMS */ - CONTACTS_PLOG_TYPE_SMS_INCOMING = 103, /**< Incoming SMS */ - CONTACTS_PLOG_TYPE_SMS_OUTGOING = 104, /**< Outgoing SMS */ - CONTACTS_PLOG_TYPE_SMS_BLOCKED = 105, /**< Blocked SMS */ - CONTACTS_PLOG_TYPE_MMS_BLOCKED = 106, /**< Blocked MMS */ - - CONTACTS_PLOG_TYPE_EMAIL_RECEIVED = 201, /**< Received email */ - CONTACTS_PLOG_TYPE_EMAIL_SENT = 202, /**< Sent email */ + CONTACTS_PLOG_TYPE_NONE, /**< None */ + CONTACTS_PLOG_TYPE_VOICE_INCOMING = 1, /**< Incoming call */ + CONTACTS_PLOG_TYPE_VOICE_OUTGOING = 2, /**< Outgoing call */ + CONTACTS_PLOG_TYPE_VIDEO_INCOMING = 3, /**< Incoming video call */ + CONTACTS_PLOG_TYPE_VIDEO_OUTGOING = 4, /**< Outgoing video call */ + CONTACTS_PLOG_TYPE_VOICE_INCOMING_UNSEEN = 5, /**< Not confirmed missed call */ + CONTACTS_PLOG_TYPE_VOICE_INCOMING_SEEN = 6, /**< Confirmed missed call */ + CONTACTS_PLOG_TYPE_VIDEO_INCOMING_UNSEEN = 7, /**< Not confirmed missed video call */ + CONTACTS_PLOG_TYPE_VIDEO_INCOMING_SEEN = 8, /**< Confirmed missed video call */ + CONTACTS_PLOG_TYPE_VOICE_REJECT = 9, /**< Rejected call */ + CONTACTS_PLOG_TYPE_VIDEO_REJECT = 10, /**< Rejected video call */ + CONTACTS_PLOG_TYPE_VOICE_BLOCKED = 11, /**< Blocked call */ + CONTACTS_PLOG_TYPE_VIDEO_BLOCKED = 12, /**< Blocked video call */ + + CONTACTS_PLOG_TYPE_MMS_INCOMING = 101, /**< Incoming MMS */ + CONTACTS_PLOG_TYPE_MMS_OUTGOING = 102, /**< Outgoing MMS */ + CONTACTS_PLOG_TYPE_SMS_INCOMING = 103, /**< Incoming SMS */ + CONTACTS_PLOG_TYPE_SMS_OUTGOING = 104, /**< Outgoing SMS */ + CONTACTS_PLOG_TYPE_SMS_BLOCKED = 105, /**< Blocked SMS */ + CONTACTS_PLOG_TYPE_MMS_BLOCKED = 106, /**< Blocked MMS */ + + CONTACTS_PLOG_TYPE_EMAIL_RECEIVED = 201, /**< Received email */ + CONTACTS_PLOG_TYPE_EMAIL_SENT = 202, /**< Sent email */ } contacts_phone_log_type_e; + /** * @brief Enumeration for Contact event type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_EVENT_TYPE_OTHER, /**< Other event type */ - CONTACTS_EVENT_TYPE_CUSTOM, /**< Custom event type */ - CONTACTS_EVENT_TYPE_BIRTH, /**< Birthday event type */ - CONTACTS_EVENT_TYPE_ANNIVERSARY /**< Anniversary event type */ + CONTACTS_EVENT_TYPE_OTHER, /**< Other event type */ + CONTACTS_EVENT_TYPE_CUSTOM, /**< Custom event type */ + CONTACTS_EVENT_TYPE_BIRTH, /**< Birthday event type */ + CONTACTS_EVENT_TYPE_ANNIVERSARY /**< Anniversary event type */ } contacts_event_type_e; + /** * @brief Enumeration for Contact event calendar type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_EVENT_CALENDAR_TYPE_GREGORIAN, /**< Gregorian calendar */ - CONTACTS_EVENT_CALENDAR_TYPE_CHINESE /**< Chinese calenadr */ + CONTACTS_EVENT_CALENDAR_TYPE_GREGORIAN, /**< Gregorian calendar */ + CONTACTS_EVENT_CALENDAR_TYPE_CHINESE /**< Chinese calenadr */ } contacts_event_calendar_type_e; + /** - * @brief Enumeration of Contact image type - * + * @brief Enumeration for Contact image type * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * */ typedef enum { - CONTACTS_IMAGE_TYPE_OTHER, /**< Other type */ - CONTACTS_IMAGE_TYPE_CUSTOM, /**< Custom type */ + CONTACTS_IMAGE_TYPE_OTHER, /**< Other type */ + CONTACTS_IMAGE_TYPE_CUSTOM, /**< Custom type */ } contacts_image_type_e; + /** * @brief Enumeration for usage type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_USAGE_STAT_TYPE_NONE, /**< None */ + CONTACTS_USAGE_STAT_TYPE_NONE, /**< None */ CONTACTS_USAGE_STAT_TYPE_OUTGOING_CALL, /**< Outgoing call */ - CONTACTS_USAGE_STAT_TYPE_OUTGOING_MSG, /**< Outgoing message */ + CONTACTS_USAGE_STAT_TYPE_OUTGOING_MSG, /**< Outgoing message */ CONTACTS_USAGE_STAT_TYPE_OUTGOING_EMAIL, /**< Outgoing email (Since 3.0) */ CONTACTS_USAGE_STAT_TYPE_INCOMING_CALL, /**< Incoming call (Since 3.0) */ - CONTACTS_USAGE_STAT_TYPE_INCOMING_MSG, /**< Incoming message (Since 3.0) */ + CONTACTS_USAGE_STAT_TYPE_INCOMING_MSG, /**< Incoming message (Since 3.0) */ CONTACTS_USAGE_STAT_TYPE_INCOMING_EMAIL,/**< Incoming email (Since 3.0) */ - CONTACTS_USAGE_STAT_TYPE_MISSED_CALL, /**< Missed call (Since 3.0) */ + CONTACTS_USAGE_STAT_TYPE_MISSED_CALL, /**< Missed call (Since 3.0) */ CONTACTS_USAGE_STAT_TYPE_REJECTED_CALL, /**< Rejected call (Since 3.0) */ CONTACTS_USAGE_STAT_TYPE_BLOCKED_CALL, /**< Blocked call (Since 3.0) */ CONTACTS_USAGE_STAT_TYPE_BLOCKED_MSG /**< Blocked message (Since 3.0) */ } contacts_usage_type_e; + /** * @brief Enumeration for Contact display name source type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_DISPLAY_NAME_SOURCE_TYPE_INVALID, /**< Invalid source of display name */ - CONTACTS_DISPLAY_NAME_SOURCE_TYPE_EMAIL, /**< Produced display name from email record */ - CONTACTS_DISPLAY_NAME_SOURCE_TYPE_NUMBER, /**< Produced display name from number record */ - CONTACTS_DISPLAY_NAME_SOURCE_TYPE_NICKNAME, /**< Produced display name from nickname record */ - CONTACTS_DISPLAY_NAME_SOURCE_TYPE_COMPANY, /**< Produced display name from company record */ - CONTACTS_DISPLAY_NAME_SOURCE_TYPE_NAME, /**< Produced display name from name record */ + CONTACTS_DISPLAY_NAME_SOURCE_TYPE_INVALID, /**< Invalid source of display name */ + CONTACTS_DISPLAY_NAME_SOURCE_TYPE_EMAIL, /**< Produced display name from email record */ + CONTACTS_DISPLAY_NAME_SOURCE_TYPE_NUMBER, /**< Produced display name from number record */ + CONTACTS_DISPLAY_NAME_SOURCE_TYPE_NICKNAME, /**< Produced display name from nickname record */ + CONTACTS_DISPLAY_NAME_SOURCE_TYPE_COMPANY, /**< Produced display name from company record */ + CONTACTS_DISPLAY_NAME_SOURCE_TYPE_NAME, /**< Produced display name from name record */ } contacts_display_name_source_type_e; + /** * @brief Enumeration for Address book mode. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_ADDRESS_BOOK_MODE_NONE, /**< All module can read and write contacts of this address_book */ - CONTACTS_ADDRESS_BOOK_MODE_READONLY, /**< All module can only read contacts of this address_book*/ + CONTACTS_ADDRESS_BOOK_MODE_NONE, /**< All module can read and write contacts of this address_book */ + CONTACTS_ADDRESS_BOOK_MODE_READONLY, /**< All module can only read contacts of this address_book*/ } contacts_address_book_mode_e; + /** * @brief Enumeration for link mode when inserting contact. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_CONTACT_LINK_MODE_NONE, /**< Auto link immediately */ - CONTACTS_CONTACT_LINK_MODE_IGNORE_ONCE, /**< Do not auto link when the contact is inserted */ + CONTACTS_CONTACT_LINK_MODE_NONE, /**< Auto link immediately */ + CONTACTS_CONTACT_LINK_MODE_IGNORE_ONCE, /**< Do not auto link when the contact is inserted */ } contacts_contact_link_mode_e; + /** * @brief Enumeration for Contact relationship type. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_RELATIONSHIP_TYPE_OTHER, /**< Other relationship type*/ - CONTACTS_RELATIONSHIP_TYPE_ASSISTANT, /**< Assistant type */ - CONTACTS_RELATIONSHIP_TYPE_BROTHER, /**< Brother type */ - CONTACTS_RELATIONSHIP_TYPE_CHILD, /**< Child type */ - CONTACTS_RELATIONSHIP_TYPE_DOMESTIC_PARTNER, /**< Domestic Partner type */ - CONTACTS_RELATIONSHIP_TYPE_FATHER, /**< Father type */ - CONTACTS_RELATIONSHIP_TYPE_FRIEND, /**< Friend type */ - CONTACTS_RELATIONSHIP_TYPE_MANAGER, /**< Manager type */ - CONTACTS_RELATIONSHIP_TYPE_MOTHER, /**< Mother type */ - CONTACTS_RELATIONSHIP_TYPE_PARENT, /**< Parent type */ - CONTACTS_RELATIONSHIP_TYPE_PARTNER, /**< Partner type */ - CONTACTS_RELATIONSHIP_TYPE_REFERRED_BY, /**< Referred by type */ - CONTACTS_RELATIONSHIP_TYPE_RELATIVE, /**< Relative type */ - CONTACTS_RELATIONSHIP_TYPE_SISTER, /**< Sister type */ - CONTACTS_RELATIONSHIP_TYPE_SPOUSE, /**< Spouse type */ - CONTACTS_RELATIONSHIP_TYPE_CUSTOM, /**< Custom type */ + CONTACTS_RELATIONSHIP_TYPE_OTHER, /**< Other relationship type*/ + CONTACTS_RELATIONSHIP_TYPE_ASSISTANT, /**< Assistant type */ + CONTACTS_RELATIONSHIP_TYPE_BROTHER, /**< Brother type */ + CONTACTS_RELATIONSHIP_TYPE_CHILD, /**< Child type */ + CONTACTS_RELATIONSHIP_TYPE_DOMESTIC_PARTNER, /**< Domestic Partner type */ + CONTACTS_RELATIONSHIP_TYPE_FATHER, /**< Father type */ + CONTACTS_RELATIONSHIP_TYPE_FRIEND, /**< Friend type */ + CONTACTS_RELATIONSHIP_TYPE_MANAGER, /**< Manager type */ + CONTACTS_RELATIONSHIP_TYPE_MOTHER, /**< Mother type */ + CONTACTS_RELATIONSHIP_TYPE_PARENT, /**< Parent type */ + CONTACTS_RELATIONSHIP_TYPE_PARTNER, /**< Partner type */ + CONTACTS_RELATIONSHIP_TYPE_REFERRED_BY, /**< Referred by type */ + CONTACTS_RELATIONSHIP_TYPE_RELATIVE, /**< Relative type */ + CONTACTS_RELATIONSHIP_TYPE_SISTER, /**< Sister type */ + CONTACTS_RELATIONSHIP_TYPE_SPOUSE, /**< Spouse type */ + CONTACTS_RELATIONSHIP_TYPE_CUSTOM, /**< Custom type */ } contacts_relationship_type_e; + /** * @brief Enumeration for Contact search range. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * */ typedef enum { - CONTACTS_SEARCH_RANGE_NAME = 0x00000001, /**< Search record from name */ - CONTACTS_SEARCH_RANGE_NUMBER = 0x00000002, /**< Search record from name and number */ - CONTACTS_SEARCH_RANGE_DATA = 0x00000004, /**< Search record from name,number and data */ - CONTACTS_SEARCH_RANGE_EMAIL = 0x00000008, /**< Search record from name,number,data and email. Now, support only _contacts_person_email view_uri*/ + CONTACTS_SEARCH_RANGE_NAME = 0x00000001, /**< Search record from name */ + CONTACTS_SEARCH_RANGE_NUMBER = 0x00000002, /**< Search record from name and number */ + CONTACTS_SEARCH_RANGE_DATA = 0x00000004, /**< Search record from name,number and data */ + CONTACTS_SEARCH_RANGE_EMAIL = 0x00000008, /**< Search record from name,number,data and email. Now, support only _contacts_person_email view_uri*/ } contacts_search_range_e; + /** * @brief Enumeration for SIP(Session Intialion Protocol) type range - * * @since_tizen 3.0 - * */ typedef enum { - CONTACTS_SIP_TYPE_OTHER, /**< Other sip type */ - CONTACTS_SIP_TYPE_CUSTOM, /**< Custom sip type */ - CONTACTS_SIP_TYPE_HOME, /**< Home sip type */ - CONTACTS_SIP_TYPE_WORK, /**< Work sip type */ + CONTACTS_SIP_TYPE_OTHER, /**< Other sip type */ + CONTACTS_SIP_TYPE_CUSTOM, /**< Custom sip type */ + CONTACTS_SIP_TYPE_HOME, /**< Home sip type */ + CONTACTS_SIP_TYPE_WORK, /**< Work sip type */ } contacts_sip_type_e; + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_TYPES_H__ */ diff --git a/include/contacts_vcard.h b/include/contacts_vcard.h index d32702f..9fd8fca 100644 --- a/include/contacts_vcard.h +++ b/include/contacts_vcard.h @@ -16,6 +16,8 @@ * limitations under the License. * */ + + #ifndef __TIZEN_SOCIAL_CONTACTS_VCARD_H__ #define __TIZEN_SOCIAL_CONTACTS_VCARD_H__ @@ -25,19 +27,18 @@ extern "C" { #endif + /** * @file contacts_vcard.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_VCARD_MODULE vCard - * * @brief The contacts record API provides the set of definitions and interfaces that enable application developers to get/set data from/to vCard. - * * @section CAPI_SOCIAL_CONTACTS_SVC_VCARD_MODULE_HEADER Required Header - * \#include - * + * \#include *
* @{ */ @@ -45,194 +46,159 @@ extern "C" /** * @brief Called to get a record handle of @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] record The record handle - * @param[in] user_data The user data passed from the foreach function - * - * @return @c true to continue with the next iteration of the loop, - * otherwise @c false to break out of the loop - * + * @param[in] record The record handle + * @param[in] user_data The user data passed from the foreach function + * @return @c true to continue with the next iteration of the loop, + * otherwise @c false to break out of the loop * @pre contacts_vcard_parse_to_contact_foreach() will invoke this callback. - * * @see contacts_vcard_parse_to_contact_foreach() */ typedef bool (*contacts_vcard_parse_cb)(contacts_record_h record, void *user_data); + /** * @brief Retrieves all contacts with a record handle (_contacts_contact) from a vCard file. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] vcard_file_path The file path of vCard stream file - * @param[in] callback The callback function to invoke - * @param[in] user_data The user data to be passed to the callback function - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist - * @retval #CONTACTS_ERROR_SYSTEM System error - * - * @pre contacts_connect() should be called to initialize. - * @post This function invokes contacts_vcard_parse_cb(). - * - * @see contacts_vcard_parse_cb() + * @param[in] vcard_file_path The file path of vCard stream file + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_NO_DATA Requested data does not exist + * @retval #CONTACTS_ERROR_SYSTEM System error + * @pre contacts_connect() should be called to initialize. + * @post This function invokes contacts_vcard_parse_cb(). + * @see contacts_vcard_parse_cb() */ int contacts_vcard_parse_to_contact_foreach(const char *vcard_file_path, contacts_vcard_parse_cb callback, void *user_data); + /** * @brief Retrieves all contacts with a contacts list from a vCard stream. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] vcard_stream The vCard stream - * @param[out] contacts_list The contacts list handle - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * - * @pre contacts_connect() should be called to initialize. - * + * @param[in] vcard_stream The vCard stream + * @param[out] contacts_list The contacts list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @pre contacts_connect() should be called to initialize. */ int contacts_vcard_parse_to_contacts(const char *vcard_stream, contacts_list_h *contacts_list); + /** * @brief Retrieves the vCard stream from a contact. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] contact The contact record handle - * @param[out] vcard_stream The vCard stream - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @param[in] contact The contact record handle + * @param[out] vcard_stream The vCard stream + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter */ int contacts_vcard_make_from_contact(contacts_record_h contact, char **vcard_stream); + /** * @brief Retrieves the vCard stream from a contact. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] my_profile The my_profile record handle - * @param[out] vcard_stream The vCard stream - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @param[in] my_profile The my_profile record handle + * @param[out] vcard_stream The vCard stream + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter */ int contacts_vcard_make_from_my_profile(contacts_record_h my_profile, char **vcard_stream); /** * @brief Retrieves the vCard stream from a person. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * - * @param[in] person The person record handle - * @param[out] vcard_stream The vCard stream - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. - * @retval #CONTACTS_ERROR_DB DB error - * @retval #CONTACTS_ERROR_IPC IPC error - * - * @pre contacts_connect() should be called to initialize. - * + * @param[in] person The person record handle + * @param[out] vcard_stream The vCard stream + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_FILE_NO_SPACE FS Full + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method + * @retval #CONTACTS_ERROR_DB DB error + * @retval #CONTACTS_ERROR_IPC IPC error + * @pre contacts_connect() should be called to initialize. */ int contacts_vcard_make_from_person(contacts_record_h person, char **vcard_stream); + /** * @brief Retrieves the count of contact entities from a vCard file. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif - * - * @param[in] vcard_file_path The person record handle - * @param[out] count The count of contact entity - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_SYSTEM System error + * @param[in] vcard_file_path The person record handle + * @param[out] count The count of contact entity + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_SYSTEM System error */ int contacts_vcard_get_entity_count(const char *vcard_file_path, int *count); + /** * @brief Gets the limit size of width and height of photos to append in vCard streams. - * * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read - * - * @param[out] limit_size The limit size of width and height of photos to append in vCard streams. It's in pixels. - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. + * @param[out] limit_size The limit size of width and height of photos to append in vCard streams. It's in pixels + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method */ int contacts_vcard_get_limit_size_of_photo(unsigned int *limit_size); + /** * @brief Sets the limit size of width and height of photos to append to vCard streams. - * * @details This function can be used for getting reduced vCard stream. \n - * When making vCard stream by using contacts_vcard_make_from_person(), contacts_vcard_make_from_my_profile(), contacts_vcard_make_from_contact(), \n - * if width or height of the photo to append is bigger than the limit size, it is reduced to the limit size while maintaining original aspect ratio, \n - * so that vCard stream size can be reduced - * + * When making vCard stream by using contacts_vcard_make_from_person(), contacts_vcard_make_from_my_profile(), contacts_vcard_make_from_contact(), \n + * if width or height of the photo to append is bigger than the limit size, it is reduced to the limit size while maintaining original aspect ratio, \n + * so that vCard stream size can be reduced. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.write - * * @remarks The limit_size should be bigger than or equal to 8 and smaller than 1080. - * - * @param[in] limit_size The limit size of width and height of photos to append in vCard streams. It's in pixels. - * - * @return @c 0 on success, - * otherwise a negative error value - * - * @retval #CONTACTS_ERROR_NONE Successful - * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. + * @param[in] limit_size The limit size of width and height of photos to append in vCard streams. It's in pixels + * @return @c 0 on success, + * otherwise a negative error value + * @retval #CONTACTS_ERROR_NONE Successful + * @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method */ int contacts_vcard_set_limit_size_of_photo(unsigned int limit_size); + /** * @} */ + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_VCARD_H__ */ diff --git a/include/contacts_views.h b/include/contacts_views.h index 180adf1..0817008 100644 --- a/include/contacts_views.h +++ b/include/contacts_views.h @@ -17,37 +17,36 @@ * */ + #ifndef __TIZEN_SOCIAL_CONTACTS_VIEWS_H__ #define __TIZEN_SOCIAL_CONTACTS_VIEWS_H__ + #include "contacts_types.h" + #ifdef __cplusplus extern "C" { #endif + /** * @file contacts_views.h */ + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property - * * @brief This page provides information about views with properties. - * * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_HEADER Required Header - * \#include - * + * \#include * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_OVERVIEW Overview * In this category, application developers can find tables with view properties. - * * A view is a structure which describes properties of a record. - * * A record can have basic properties of five types: integer, string, boolean, long integer, double. Each property * of basic type has functions to operate on it: - * * * * @@ -80,23 +79,17 @@ extern "C" * * *
Property type @ref contacts_record_get_double
- * * For long integer functions, "lli" stands for long long int, usually used to hold UTC time. - * * Record types which have *_id as their properties, hold identifiers of other records - for example, name, number and email * views hold ID of their corresponding contacts in contact_id property * (as children of the corresponding contacts record). - * * Properties of type 'record' are other records. For example, the _contacts_contact view * has a 'name' property of type 'record'. This means that records of type name (_contacts_name view) * can be children of the contact record. If a name record holds the identifier * of a contact record in its 'contact_id' property, it is the child record of the corresponding * contact record. - * * Records can have many children of a given type. - * * For a more detailed explanation and examples, see the main section of Contacts API. - * *
*/ @@ -119,12 +112,13 @@ extern "C" * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(account_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(name) /* read, write */ - _CONTACTS_PROPERTY_INT(mode) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(account_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(name) /* read, write */ + _CONTACTS_PROPERTY_INT(mode) /* read, write */ _CONTACTS_END_VIEW(_contacts_address_book) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group _contacts_group view @@ -149,17 +143,18 @@ _CONTACTS_END_VIEW(_contacts_address_book) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(address_book_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(name) /* read, write */ - _CONTACTS_PROPERTY_STR(ringtone_path) /* read, write */ - _CONTACTS_PROPERTY_STR(image_path) /* read, write */ - _CONTACTS_PROPERTY_STR(vibration) /* read, write */ - _CONTACTS_PROPERTY_STR(extra_data) /* read, write, string */ - _CONTACTS_PROPERTY_BOOL(is_read_only) /* read, write once */ - _CONTACTS_PROPERTY_STR(message_alert) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(address_book_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(name) /* read, write */ + _CONTACTS_PROPERTY_STR(ringtone_path) /* read, write */ + _CONTACTS_PROPERTY_STR(image_path) /* read, write */ + _CONTACTS_PROPERTY_STR(vibration) /* read, write */ + _CONTACTS_PROPERTY_STR(extra_data) /* read, write, string */ + _CONTACTS_PROPERTY_BOOL(is_read_only) /* read, write once */ + _CONTACTS_PROPERTY_STR(message_alert) /* read, write */ _CONTACTS_END_VIEW(_contacts_group) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person _contacts_person view @@ -181,7 +176,7 @@ _CONTACTS_END_VIEW(_contacts_group) * string message_alert read, write Message alert path of the person * string status read only Status of social account * boolean is_favorite read, write The person is favorite or not - * double favorite_priority read only The priority of favorite contacts. it can be used as sorting key, see the @ref contacts_query_set_sort + * double favorite_priority sort only The priority of favorite contacts. You cannot get/set the value but you can use it as sorting key, see the @ref contacts_query_set_sort * integer link_count read only Link count of contact records (projection) * string addressbook_ids read only Addressbook IDs that the person belongs to (projection) * boolean has_phonenumber read only The person has phone number or not @@ -191,25 +186,26 @@ _CONTACTS_END_VIEW(_contacts_group) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_STR(display_name) /* read only */ - _CONTACTS_PROPERTY_STR(display_name_index) /* read only */ - _CONTACTS_PROPERTY_INT(display_contact_id) /* read, write */ - _CONTACTS_PROPERTY_STR(ringtone_path) /* read, write */ - _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ - _CONTACTS_PROPERTY_STR(vibration) /* read, write */ - _CONTACTS_PROPERTY_STR(status) /* read only */ - _CONTACTS_PROPERTY_BOOL(is_favorite) /* read, write */ - _CONTACTS_PROPERTY_DOUBLE(favorite_priority) /* read only */ - _CONTACTS_PROPERTY_INT(link_count) /* read only */ - _CONTACTS_PROPERTY_STR(addressbook_ids) /* read only */ - _CONTACTS_PROPERTY_BOOL(has_phonenumber) /* read only */ - _CONTACTS_PROPERTY_BOOL(has_email) /* read only */ - _CONTACTS_PROPERTY_STR(message_alert) /* read, write */ - _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ - _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_STR(display_name) /* read only */ + _CONTACTS_PROPERTY_STR(display_name_index) /* read only */ + _CONTACTS_PROPERTY_INT(display_contact_id) /* read, write */ + _CONTACTS_PROPERTY_STR(ringtone_path) /* read, write */ + _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ + _CONTACTS_PROPERTY_STR(vibration) /* read, write */ + _CONTACTS_PROPERTY_STR(status) /* read only */ + _CONTACTS_PROPERTY_BOOL(is_favorite) /* read, write */ + _CONTACTS_PROPERTY_DOUBLE(favorite_priority) /* sort only */ + _CONTACTS_PROPERTY_INT(link_count) /* read only */ + _CONTACTS_PROPERTY_STR(addressbook_ids) /* read only */ + _CONTACTS_PROPERTY_BOOL(has_phonenumber) /* read only */ + _CONTACTS_PROPERTY_BOOL(has_email) /* read only */ + _CONTACTS_PROPERTY_STR(message_alert) /* read, write */ + _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ _CONTACTS_END_VIEW(_contacts_person) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_simple_contact _contacts_simple_contact view @@ -239,33 +235,34 @@ _CONTACTS_END_VIEW(_contacts_person) * */ _CONTACTS_BEGIN_READ_ONLY_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_STR(display_name) /* read only */ - _CONTACTS_PROPERTY_INT(display_source_type) /* read only */ - _CONTACTS_PROPERTY_INT(address_book_id) /* read only */ - _CONTACTS_PROPERTY_STR(ringtone_path) /* read only */ - _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ - _CONTACTS_PROPERTY_BOOL(is_favorite) /* read only */ - _CONTACTS_PROPERTY_BOOL(has_phonenumber) /* read only */ - _CONTACTS_PROPERTY_BOOL(has_email) /* read only */ - _CONTACTS_PROPERTY_INT(person_id) /* read only */ - _CONTACTS_PROPERTY_STR(uid) /* read only */ - _CONTACTS_PROPERTY_STR(vibration) /* read only */ - _CONTACTS_PROPERTY_INT(changed_time) /* read only */ - _CONTACTS_PROPERTY_STR(message_alert) /* read only */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_STR(display_name) /* read only */ + _CONTACTS_PROPERTY_INT(display_source_type) /* read only */ + _CONTACTS_PROPERTY_INT(address_book_id) /* read only */ + _CONTACTS_PROPERTY_STR(ringtone_path) /* read only */ + _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ + _CONTACTS_PROPERTY_BOOL(is_favorite) /* read only */ + _CONTACTS_PROPERTY_BOOL(has_phonenumber) /* read only */ + _CONTACTS_PROPERTY_BOOL(has_email) /* read only */ + _CONTACTS_PROPERTY_INT(person_id) /* read only */ + _CONTACTS_PROPERTY_STR(uid) /* read only */ + _CONTACTS_PROPERTY_STR(vibration) /* read only */ + _CONTACTS_PROPERTY_INT(changed_time) /* read only */ + _CONTACTS_PROPERTY_STR(message_alert) /* read only */ _CONTACTS_END_READ_ONLY_VIEW(_contacts_simple_contact) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact _contacts_contact view * * - * + * * * * * - * + * * * * @@ -299,39 +296,40 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_simple_contact) *
TypeTypeProperty IDRead, WriteDescription
string_uriread only Identifier of this contact view
string_uriread only Identifier of this contact view
integeridread only DB record ID of the contact
stringdisplay_nameread only Display name of the contact
integerdisplay_source_idread only The source type of display name, refer to the @ref contacts_display_name_source_type_e
*/ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_STR(display_name) /* read only */ - _CONTACTS_PROPERTY_INT(display_source_type) /* read only */ - _CONTACTS_PROPERTY_INT(address_book_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(ringtone_path) /* read, write */ - _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ - _CONTACTS_PROPERTY_BOOL(is_favorite) /* read, write */ - _CONTACTS_PROPERTY_BOOL(has_phonenumber) /* read only */ - _CONTACTS_PROPERTY_BOOL(has_email) /* read only */ - _CONTACTS_PROPERTY_INT(person_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(uid) /* read, write */ - _CONTACTS_PROPERTY_STR(vibration) /* read, write */ - _CONTACTS_PROPERTY_INT(changed_time) /* read only */ - _CONTACTS_PROPERTY_INT(link_mode) /* read, write */ - _CONTACTS_PROPERTY_CHILD_SINGLE(name) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(image) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(company) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(note) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(number) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(email) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(event) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(messenger) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(address) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(url) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(nickname) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(profile) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(relationship) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_STR(display_name) /* read only */ + _CONTACTS_PROPERTY_INT(display_source_type) /* read only */ + _CONTACTS_PROPERTY_INT(address_book_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(ringtone_path) /* read, write */ + _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ + _CONTACTS_PROPERTY_BOOL(is_favorite) /* read, write */ + _CONTACTS_PROPERTY_BOOL(has_phonenumber) /* read only */ + _CONTACTS_PROPERTY_BOOL(has_email) /* read only */ + _CONTACTS_PROPERTY_INT(person_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(uid) /* read, write */ + _CONTACTS_PROPERTY_STR(vibration) /* read, write */ + _CONTACTS_PROPERTY_INT(changed_time) /* read only */ + _CONTACTS_PROPERTY_INT(link_mode) /* read, write */ + _CONTACTS_PROPERTY_CHILD_SINGLE(name) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(image) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(company) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(note) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(number) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(email) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(event) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(messenger) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(address) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(url) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(nickname) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(profile) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(relationship) /* read, write */ _CONTACTS_PROPERTY_CHILD_MULTIPLE(group_relation) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(extension) /* read, write */ - _CONTACTS_PROPERTY_STR(message_alert) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(sip) /* read, write (Since 3.0) */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(extension) /* read, write */ + _CONTACTS_PROPERTY_STR(message_alert) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(sip) /* read, write (Since 3.0) */ _CONTACTS_END_VIEW(_contacts_contact) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile _contacts_my_profile view @@ -366,27 +364,27 @@ _CONTACTS_END_VIEW(_contacts_contact) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_STR(display_name) /* read only */ - _CONTACTS_PROPERTY_INT(address_book_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ - _CONTACTS_PROPERTY_STR(uid) /* read, write */ - _CONTACTS_PROPERTY_INT(changed_time) /* read only */ - _CONTACTS_PROPERTY_CHILD_SINGLE(name) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(image) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(company) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(note) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(number) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(email) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(event) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(messenger) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(address) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(url) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(nickname) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(profile) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(relationship) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(extension) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(sip) /* read, write (Since 3.0) */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_STR(display_name) /* read only */ + _CONTACTS_PROPERTY_INT(address_book_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ + _CONTACTS_PROPERTY_STR(uid) /* read, write */ + _CONTACTS_PROPERTY_INT(changed_time) /* read only */ + _CONTACTS_PROPERTY_CHILD_SINGLE(name) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(image) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(company) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(note) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(number) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(email) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(event) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(messenger) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(address) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(url) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(nickname) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(profile) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(relationship) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(extension) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(sip) /* read, write (Since 3.0) */ _CONTACTS_END_VIEW(_contacts_my_profile) @@ -409,26 +407,26 @@ _CONTACTS_END_VIEW(_contacts_my_profile) * string suffix read, write Suffix * string prefix read, write Prefix * string phonetic_first read, write Pronounce the first name - * string phonetic_middle read, write Pronounce the middle name + * string phonetic_middle read, write Pronounce the middle name * string phonetic_last read, write Pronounce the last name * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(first) /* read, write */ - _CONTACTS_PROPERTY_STR(last) /* read, write */ - _CONTACTS_PROPERTY_STR(addition) /* read, write */ - _CONTACTS_PROPERTY_STR(suffix) /* read, write */ - _CONTACTS_PROPERTY_STR(prefix) /* read, write */ - _CONTACTS_PROPERTY_STR(phonetic_first) /* read, write */ - _CONTACTS_PROPERTY_STR(phonetic_middle) /* read, write */ - _CONTACTS_PROPERTY_STR(phonetic_last) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(first) /* read, write */ + _CONTACTS_PROPERTY_STR(last) /* read, write */ + _CONTACTS_PROPERTY_STR(addition) /* read, write */ + _CONTACTS_PROPERTY_STR(suffix) /* read, write */ + _CONTACTS_PROPERTY_STR(prefix) /* read, write */ + _CONTACTS_PROPERTY_STR(phonetic_first) /* read, write */ + _CONTACTS_PROPERTY_STR(phonetic_middle) /* read, write */ + _CONTACTS_PROPERTY_STR(phonetic_last) /* read, write */ _CONTACTS_END_VIEW(_contacts_name) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property - * * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_number _contacts_number view * * @@ -450,17 +448,18 @@ _CONTACTS_END_VIEW(_contacts_name) *
*/ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ - _CONTACTS_PROPERTY_BOOL(is_default) /* read, write */ - _CONTACTS_PROPERTY_STR(number) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ + _CONTACTS_PROPERTY_BOOL(is_default) /* read, write */ + _CONTACTS_PROPERTY_STR(number) /* read, write */ _CONTACTS_PROPERTY_STR(normalized_number) /* filter only */ - _CONTACTS_PROPERTY_STR(cleaned_number) /* filter only */ - _CONTACTS_PROPERTY_STR(number_filter) /* filter only */ + _CONTACTS_PROPERTY_STR(cleaned_number) /* filter only */ + _CONTACTS_PROPERTY_STR(number_filter) /* filter only */ _CONTACTS_END_VIEW(_contacts_number) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_email _contacts_email view @@ -474,21 +473,22 @@ _CONTACTS_END_VIEW(_contacts_number) * string_uriread only Identifier of this contacts email view * integer id read only DB record ID of the email * integer contact_id read, write once Contact ID that the email belongs to - * integer type read, write Email type, refer to the @ref contacts_email_type_e + * integer type read, write Email type, refer to the @ref contacts_email_type_e * string label read, write Custom mail type label, when the email type is #CONTACTS_EMAIL_TYPE_CUSTOM - * boolean is_default read, write The email is default email or not + * boolean is_default read, write The email is default email or not * string email read, write Email address * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ - _CONTACTS_PROPERTY_BOOL(is_default) /* read, write */ - _CONTACTS_PROPERTY_STR(email) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ + _CONTACTS_PROPERTY_BOOL(is_default) /* read, write */ + _CONTACTS_PROPERTY_STR(email) /* read, write */ _CONTACTS_END_VIEW(_contacts_email) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_address _contacts_address view @@ -515,20 +515,21 @@ _CONTACTS_END_VIEW(_contacts_email) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ - _CONTACTS_PROPERTY_STR(postbox) /* read, write */ - _CONTACTS_PROPERTY_STR(extended) /* read, write */ - _CONTACTS_PROPERTY_STR(street) /* read, write */ - _CONTACTS_PROPERTY_STR(locality) /* read, write */ - _CONTACTS_PROPERTY_STR(region) /* read, write */ - _CONTACTS_PROPERTY_STR(postal_code) /* read, write */ - _CONTACTS_PROPERTY_STR(country) /* read, write */ - _CONTACTS_PROPERTY_BOOL(is_default) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ + _CONTACTS_PROPERTY_STR(postbox) /* read, write */ + _CONTACTS_PROPERTY_STR(extended) /* read, write */ + _CONTACTS_PROPERTY_STR(street) /* read, write */ + _CONTACTS_PROPERTY_STR(locality) /* read, write */ + _CONTACTS_PROPERTY_STR(region) /* read, write */ + _CONTACTS_PROPERTY_STR(postal_code) /* read, write */ + _CONTACTS_PROPERTY_STR(country) /* read, write */ + _CONTACTS_PROPERTY_BOOL(is_default) /* read, write */ _CONTACTS_END_VIEW(_contacts_address) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_note _contacts_note view @@ -546,11 +547,12 @@ _CONTACTS_END_VIEW(_contacts_address) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(note) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(note) /* read, write */ _CONTACTS_END_VIEW(_contacts_note) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_url _contacts_url view @@ -570,13 +572,14 @@ _CONTACTS_END_VIEW(_contacts_note) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ - _CONTACTS_PROPERTY_STR(url) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ + _CONTACTS_PROPERTY_STR(url) /* read, write */ _CONTACTS_END_VIEW(_contacts_url) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_event _contacts_event view @@ -598,15 +601,16 @@ _CONTACTS_END_VIEW(_contacts_url) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ - _CONTACTS_PROPERTY_INT(date) /* read, write */ - _CONTACTS_PROPERTY_INT(calendar_type) /* read, write */ - _CONTACTS_PROPERTY_BOOL(is_leap_month) /* read, write (Deprecated since 2.4) */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ + _CONTACTS_PROPERTY_INT(date) /* read, write */ + _CONTACTS_PROPERTY_INT(calendar_type) /* read, write */ + _CONTACTS_PROPERTY_BOOL(is_leap_month) /* read, write (Deprecated since 2.4) */ _CONTACTS_END_VIEW(_contacts_event) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group_relation _contacts_group_relation view @@ -626,12 +630,13 @@ _CONTACTS_END_VIEW(_contacts_event) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only, can not be used as filter */ - _CONTACTS_PROPERTY_INT(group_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(name) /* read only */ + _CONTACTS_PROPERTY_INT(id) /* read only, can not be used as filter */ + _CONTACTS_PROPERTY_INT(group_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(name) /* read only */ _CONTACTS_END_VIEW(_contacts_group_relation) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_relationship _contacts_relationship view @@ -652,13 +657,14 @@ _CONTACTS_END_VIEW(_contacts_group_relation) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ - _CONTACTS_PROPERTY_STR(name) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ + _CONTACTS_PROPERTY_STR(name) /* read, write */ _CONTACTS_END_VIEW(_contacts_relationship) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_image _contacts_image view @@ -678,14 +684,15 @@ _CONTACTS_END_VIEW(_contacts_relationship) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ - _CONTACTS_PROPERTY_STR(path) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ + _CONTACTS_PROPERTY_STR(path) /* read, write */ _CONTACTS_PROPERTY_BOOL(is_default) _CONTACTS_END_VIEW(_contacts_image) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_company _contacts_company view @@ -713,21 +720,22 @@ _CONTACTS_END_VIEW(_contacts_image) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ - _CONTACTS_PROPERTY_STR(name) /* read, write */ - _CONTACTS_PROPERTY_STR(department) /* read, write */ - _CONTACTS_PROPERTY_STR(job_title) /* read, write */ - _CONTACTS_PROPERTY_STR(assistant_name) /* read, write */ - _CONTACTS_PROPERTY_STR(role) /* read, write */ - _CONTACTS_PROPERTY_STR(logo) /* read, write */ - _CONTACTS_PROPERTY_STR(location) /* read, write */ - _CONTACTS_PROPERTY_STR(description) /* read, write */ - _CONTACTS_PROPERTY_STR(phonetic_name) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ + _CONTACTS_PROPERTY_STR(name) /* read, write */ + _CONTACTS_PROPERTY_STR(department) /* read, write */ + _CONTACTS_PROPERTY_STR(job_title) /* read, write */ + _CONTACTS_PROPERTY_STR(assistant_name) /* read, write */ + _CONTACTS_PROPERTY_STR(role) /* read, write */ + _CONTACTS_PROPERTY_STR(logo) /* read, write */ + _CONTACTS_PROPERTY_STR(location) /* read, write */ + _CONTACTS_PROPERTY_STR(description) /* read, write */ + _CONTACTS_PROPERTY_STR(phonetic_name) /* read, write */ _CONTACTS_END_VIEW(_contacts_company) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_nickname _contacts_nickname view @@ -745,11 +753,12 @@ _CONTACTS_END_VIEW(_contacts_company) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(name) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(name) /* read, write */ _CONTACTS_END_VIEW(_contacts_nickname) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_messenger _contacts_messenger view @@ -769,13 +778,14 @@ _CONTACTS_END_VIEW(_contacts_nickname) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ - _CONTACTS_PROPERTY_STR(im_id) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ + _CONTACTS_PROPERTY_STR(im_id) /* read, write */ _CONTACTS_END_VIEW(_contacts_messenger) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_extension _contacts_extension view @@ -804,22 +814,23 @@ _CONTACTS_END_VIEW(_contacts_messenger) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_INT(data1) /* read, write */ - _CONTACTS_PROPERTY_STR(data2) /* read, write */ - _CONTACTS_PROPERTY_STR(data3) /* read, write */ - _CONTACTS_PROPERTY_STR(data4) /* read, write */ - _CONTACTS_PROPERTY_STR(data5) /* read, write */ - _CONTACTS_PROPERTY_STR(data6) /* read, write */ - _CONTACTS_PROPERTY_STR(data7) /* read, write */ - _CONTACTS_PROPERTY_STR(data8) /* read, write */ - _CONTACTS_PROPERTY_STR(data9) /* read, write */ - _CONTACTS_PROPERTY_STR(data10) /* read, write */ - _CONTACTS_PROPERTY_STR(data11) /* read, write */ - _CONTACTS_PROPERTY_STR(data12) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(data1) /* read, write */ + _CONTACTS_PROPERTY_STR(data2) /* read, write */ + _CONTACTS_PROPERTY_STR(data3) /* read, write */ + _CONTACTS_PROPERTY_STR(data4) /* read, write */ + _CONTACTS_PROPERTY_STR(data5) /* read, write */ + _CONTACTS_PROPERTY_STR(data6) /* read, write */ + _CONTACTS_PROPERTY_STR(data7) /* read, write */ + _CONTACTS_PROPERTY_STR(data8) /* read, write */ + _CONTACTS_PROPERTY_STR(data9) /* read, write */ + _CONTACTS_PROPERTY_STR(data10) /* read, write */ + _CONTACTS_PROPERTY_STR(data11) /* read, write */ + _CONTACTS_PROPERTY_STR(data12) /* read, write */ _CONTACTS_END_VIEW(_contacts_extension) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sdn _contacts_sdn view @@ -838,12 +849,13 @@ _CONTACTS_END_VIEW(_contacts_extension) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_STR(name) /* read only */ - _CONTACTS_PROPERTY_STR(number) /* read only */ - _CONTACTS_PROPERTY_INT(sim_slot_no) /* read only */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_STR(name) /* read only */ + _CONTACTS_PROPERTY_STR(number) /* read only */ + _CONTACTS_PROPERTY_INT(sim_slot_no) /* read only */ _CONTACTS_END_VIEW(_contacts_sdn) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_profile _contacts_profile view @@ -869,19 +881,20 @@ _CONTACTS_END_VIEW(_contacts_sdn) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_STR(uid) /* read, write */ - _CONTACTS_PROPERTY_STR(text) /* read, write */ - _CONTACTS_PROPERTY_INT(order) /* read, write */ - _CONTACTS_PROPERTY_STR(service_operation) /* read, write */ - _CONTACTS_PROPERTY_STR(mime) /* read, write */ - _CONTACTS_PROPERTY_STR(app_id) /* read, write */ - _CONTACTS_PROPERTY_STR(uri) /* read, write */ - _CONTACTS_PROPERTY_STR(category) /* read, write */ - _CONTACTS_PROPERTY_STR(extra_data) /* read, write */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_STR(uid) /* read, write */ + _CONTACTS_PROPERTY_STR(text) /* read, write */ + _CONTACTS_PROPERTY_INT(order) /* read, write */ + _CONTACTS_PROPERTY_STR(service_operation) /* read, write */ + _CONTACTS_PROPERTY_STR(mime) /* read, write */ + _CONTACTS_PROPERTY_STR(app_id) /* read, write */ + _CONTACTS_PROPERTY_STR(uri) /* read, write */ + _CONTACTS_PROPERTY_STR(category) /* read, write */ + _CONTACTS_PROPERTY_STR(extra_data) /* read, write */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ _CONTACTS_END_VIEW(_contacts_profile) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity_photo _contacts_activity_photo view @@ -900,12 +913,13 @@ _CONTACTS_END_VIEW(_contacts_profile) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(activity_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(photo_url) /* read, write */ - _CONTACTS_PROPERTY_INT(sort_index) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(activity_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(photo_url) /* read, write */ + _CONTACTS_PROPERTY_INT(sort_index) /* read, write */ _CONTACTS_END_VIEW(_contacts_activity_photo) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_activity _contacts_activity view @@ -928,16 +942,17 @@ _CONTACTS_END_VIEW(_contacts_activity_photo) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(source_name) /* read, write */ - _CONTACTS_PROPERTY_STR(status) /* read, write */ - _CONTACTS_PROPERTY_INT(timestamp) /* read, write */ - _CONTACTS_PROPERTY_STR(service_operation) /* read, write */ - _CONTACTS_PROPERTY_STR(uri) /* read, write */ - _CONTACTS_PROPERTY_CHILD_MULTIPLE(photo) /* read, write */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(source_name) /* read, write */ + _CONTACTS_PROPERTY_STR(status) /* read, write */ + _CONTACTS_PROPERTY_INT(timestamp) /* read, write */ + _CONTACTS_PROPERTY_STR(service_operation) /* read, write */ + _CONTACTS_PROPERTY_STR(uri) /* read, write */ + _CONTACTS_PROPERTY_CHILD_MULTIPLE(photo) /* read, write */ _CONTACTS_END_VIEW(_contacts_activity) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_speeddial _contacts_speeddial view @@ -959,23 +974,24 @@ _CONTACTS_END_VIEW(_contacts_activity) * string image_thumbnail_path read only Image thumbnail path that the speed dial belongs to * string normalized_number filter only You can only use this property for search filter * string cleaned_number filter only You can only use this property for search filter - * string number_filter filter only If you add filter with this property, the string will be normalized as minmatch length internally and the match rule will be applied CONTACTS_MATCH_EXACTLY + * string number_filter filter only If you add filter with this property, the string will be normalized as minmatch length internally and the match rule will be applied CONTACTS_MATCH_EXACTLY * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(speeddial_number) /* read, write once */ - _CONTACTS_PROPERTY_INT(number_id) /* read, write */ - _CONTACTS_PROPERTY_STR(number) /* read only */ - _CONTACTS_PROPERTY_STR(number_label) /* read only */ - _CONTACTS_PROPERTY_INT(number_type) /* read only */ - _CONTACTS_PROPERTY_INT(person_id) /* read only */ - _CONTACTS_PROPERTY_STR(display_name) /* read only */ - _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ - _CONTACTS_PROPERTY_STR(normalized_number) /* filter only */ - _CONTACTS_PROPERTY_STR(cleaned_number) /* filter only */ - _CONTACTS_PROPERTY_STR(number_filter) /* filter only */ + _CONTACTS_PROPERTY_INT(speeddial_number) /* read, write once */ + _CONTACTS_PROPERTY_INT(number_id) /* read, write */ + _CONTACTS_PROPERTY_STR(number) /* read only */ + _CONTACTS_PROPERTY_STR(number_label) /* read only */ + _CONTACTS_PROPERTY_INT(number_type) /* read only */ + _CONTACTS_PROPERTY_INT(person_id) /* read only */ + _CONTACTS_PROPERTY_STR(display_name) /* read only */ + _CONTACTS_PROPERTY_STR(image_thumbnail_path) /* read only */ + _CONTACTS_PROPERTY_STR(normalized_number) /* filter only */ + _CONTACTS_PROPERTY_STR(cleaned_number) /* filter only */ + _CONTACTS_PROPERTY_STR(number_filter) /* filter only */ _CONTACTS_END_VIEW(_contacts_speeddial) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log _contacts_phone_log view @@ -1001,19 +1017,20 @@ _CONTACTS_END_VIEW(_contacts_speeddial) * */ _CONTACTS_BEGIN_VIEW() - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(person_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(address) /* read, write once, number or email */ - _CONTACTS_PROPERTY_INT(log_time) /* read, write once */ - _CONTACTS_PROPERTY_INT(log_type) /* read, write */ - _CONTACTS_PROPERTY_INT(extra_data1) /* read, write once : message or email ID, duration(seconds) */ - _CONTACTS_PROPERTY_STR(extra_data2) /* read, write once : shortmsg, subject */ - _CONTACTS_PROPERTY_STR(normalized_address) /* filter only */ - _CONTACTS_PROPERTY_STR(cleaned_address) /* filter only */ - _CONTACTS_PROPERTY_STR(address_filter) /* filter only */ - _CONTACTS_PROPERTY_INT(sim_slot_no) /* read, write once */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(person_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(address) /* read, write once, number or email */ + _CONTACTS_PROPERTY_INT(log_time) /* read, write once */ + _CONTACTS_PROPERTY_INT(log_type) /* read, write */ + _CONTACTS_PROPERTY_INT(extra_data1) /* read, write once : message or email ID, duration(seconds) */ + _CONTACTS_PROPERTY_STR(extra_data2) /* read, write once : shortmsg, subject */ + _CONTACTS_PROPERTY_STR(normalized_address) /* filter only */ + _CONTACTS_PROPERTY_STR(cleaned_address) /* filter only */ + _CONTACTS_PROPERTY_STR(address_filter) /* filter only */ + _CONTACTS_PROPERTY_INT(sim_slot_no) /* read, write once */ _CONTACTS_END_VIEW(_contacts_phone_log) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact_updated_info _contacts_contact_updated_info view (read only) @@ -1034,11 +1051,12 @@ _CONTACTS_END_VIEW(_contacts_phone_log) _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(contact_id) _CONTACTS_PROPERTY_INT(address_book_id) - _CONTACTS_PROPERTY_INT(type) /* insert/update/delete */ + _CONTACTS_PROPERTY_INT(type) /* insert/update/delete */ _CONTACTS_PROPERTY_INT(version) _CONTACTS_PROPERTY_BOOL(image_changed) _CONTACTS_END_READ_ONLY_VIEW(_contacts_contact_updated_info) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_my_profile_updated_info _contacts_my_profile_updated_info view (read only) @@ -1060,6 +1078,7 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(version) _CONTACTS_END_READ_ONLY_VIEW(_contacts_my_profile_updated_info) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_group_updated_info _contacts_group_updated_info view (read only) @@ -1079,7 +1098,7 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_my_profile_updated_info) _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(group_id) _CONTACTS_PROPERTY_INT(address_book_id) - _CONTACTS_PROPERTY_INT(type) /* insert/update/delete */ + _CONTACTS_PROPERTY_INT(type) /* insert/update/delete */ _CONTACTS_PROPERTY_INT(version) _CONTACTS_END_READ_ONLY_VIEW(_contacts_group_updated_info) @@ -1105,6 +1124,7 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(version) _CONTACTS_END_READ_ONLY_VIEW(_contacts_group_member_updated_info) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_grouprel_updated_info _contacts_grouprel_updated_info view (read only) @@ -1126,10 +1146,11 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(group_id) _CONTACTS_PROPERTY_INT(contact_id) _CONTACTS_PROPERTY_INT(address_book_id) - _CONTACTS_PROPERTY_INT(type) /* insert/delete */ + _CONTACTS_PROPERTY_INT(type) /* insert/delete */ _CONTACTS_PROPERTY_INT(version) _CONTACTS_END_READ_ONLY_VIEW(_contacts_grouprel_updated_info) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact _contacts_person_contact view (read only) @@ -1147,7 +1168,7 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_grouprel_updated_info) * string ringtone_path Ringtone path of the person (projection) * string image_thumbnail_path Image thumbnail path of the person (projection) * string vibration Vibration path of the person (projection) - * string message_alert Message alert path of the person (projection) + * string message_alert Message alert path of the person (projection) * string status Status of social account (projection) * boolean is_favorite The person is favorite or not * integer link_count Link count of contact records (projection) @@ -1181,10 +1202,11 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_STR(address_book_name) _CONTACTS_PROPERTY_INT(address_book_mode) _CONTACTS_PROPERTY_PROJECTION_STR(message_alert) - _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ - _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_contact) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_number _contacts_person_number view (read only) @@ -1202,7 +1224,7 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_contact) * string ringtone_path Ringtone path of the person (projection) * string image_thumbnail_path Image thumbnail path of the person (projection) * string vibration Vibration path of the person (projection) - * string message_alert Message alert path of the person (projection) + * string message_alert Message alert path of the person (projection) * boolean is_favorite The person is favorite or not * boolean has_phonenumber The person has phone number or not * boolean has_email The person has email or not @@ -1217,7 +1239,6 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_contact) * integer snippet_type read only kerword matched data type, refer to they @ref contacts_data_type_e (Since 3.0) * string snippet_string read only keyword matched data string (Since 3.0) * - */ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(person_id) @@ -1239,10 +1260,11 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_FILTER_STR(normalized_number) _CONTACTS_PROPERTY_PROJECTION_STR(message_alert) _CONTACTS_PROPERTY_FILTER_STR(cleaned_number) - _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ - _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_number) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_email _contacts_person_email view (read only) @@ -1260,7 +1282,7 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_number) * string ringtone_path Ringtone path of the person (projection) * string image_thumbnail_path Image thumbnail path of the person (projection) * string vibration Vibration path of the person (projection) - * string message_alert Message alert path of the person (projection) + * string message_alert Message alert path of the person (projection) * boolean is_favorite The person is favorite or not * boolean has_phonenumber The person has phone number or not * boolean has_email The person has email or not @@ -1290,10 +1312,11 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_BOOL(is_primary_default) _CONTACTS_PROPERTY_STR(email) _CONTACTS_PROPERTY_PROJECTION_STR(message_alert) - _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ - _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_email) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel _contacts_person_grouprel view (read only) @@ -1311,10 +1334,10 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_email) * string ringtone_path Ringtone path of the person (projection) * string image_thumbnail_path Image thumbnail path of the person (projection) * string vibration Vibration path of the person (projection) - * string message_alert Message alert path of the person (projection) + * string message_alert Message alert path of the person (projection) * string status Status of social account (projection) * boolean is_favorite The person is favorite or not - * integer link_count Link count of contat records (projection) + * integer link_count Link count of contat records (projection) * string addressbook_ids Addressbook IDs that the person belongs to (projection) * boolean has_phonenumber The person has phone number or not * boolean has_email The person has email or not @@ -1347,10 +1370,11 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(address_book_mode) _CONTACTS_PROPERTY_PROJECTION_INT(contact_id) _CONTACTS_PROPERTY_PROJECTION_STR(message_alert) - _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ - _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_grouprel) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned _contacts_person_group_assigned view (read only) @@ -1368,7 +1392,7 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_grouprel) * string ringtone_path Ringtone path of the person (projection) * string image_thumbnail_path Image thumbnail path of the person (projection) * string vibration Vibration path of the person (projection) - * string message_alert Message alert path of the person (projection) + * string message_alert Message alert path of the person (projection) * string status Status of social account (projection) * boolean is_favorite The person is favorite or not * integer link_count Link count of contact records (projection) @@ -1402,10 +1426,11 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(address_book_mode) _CONTACTS_PROPERTY_PROJECTION_INT(contact_id) _CONTACTS_PROPERTY_PROJECTION_STR(message_alert) - _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ - _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_group_assigned) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned _contacts_person_group_not_assigned view (read only) @@ -1420,10 +1445,10 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_group_assigned) * string display_name Display name of the person * string display_name_index The first character of first string for grouping. This is normalized using icu (projection) * integer display_contact_id Display contact ID that the person belongs to (projection) - * string ringtone_path Ringtone path of the person (projection) + * string ringtone_path Ringtone path of the person (projection) * string image_thumbnail_path Image thumbnail path of the person (projection) * string vibration Vibration path of the person (projection) - * string message_alert Message alert path of the person (projection) + * string message_alert Message alert path of the person (projection) * string status Status of social account (projection) * boolean is_favorite The person is favorite or not * integer link_count Link count of contact records (projection) @@ -1455,10 +1480,11 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(address_book_mode) _CONTACTS_PROPERTY_PROJECTION_INT(contact_id) _CONTACTS_PROPERTY_PROJECTION_STR(message_alert) - _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ - _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_INT(snippet_type) /* read only (Since 3.0) */ + _CONTACTS_PROPERTY_STR(snippet_string) /* read only (Since 3.0) */ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_group_not_assigned) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_phone_log _contacts_person_phone_log view (read only) @@ -1502,6 +1528,7 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_INT(sim_slot_no) _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_phone_log) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_usage _contacts_person_usage view (read only) @@ -1515,7 +1542,7 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_phone_log) * integer person_id DB record ID of the person * string display_name Display name of the person * string display_name_index The first character of first string for grouping. This is normalized using icu (projection) - * integer display_contact_id Display contact ID that the person belongs to (projection) + * integer display_contact_id Display contact ID that the person belongs to (projection) * string ringtone_path Ringtone path of the person (projection) * string image_thumbnail_path Image thumbnail path of the person (projection) * string vibration Vibration path of the person (projection) @@ -1543,6 +1570,7 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_PROJECTION_STR(message_alert) _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_usage) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact_number _contacts_contact_number view (read only) @@ -1558,8 +1586,8 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_person_usage) * integerdisplay_source_type The source type of display name, refer to the @ref contacts_display_name_source_type_e (projection) * integeraddress_book_id Addressbook ID that the number belongs to * integerperson_id Person ID that the number belongs to - * stringringtone_path Ringtone path that the number belongs to (projection) - * stringimage_thumbnail_path Image thumbnail path that the number belongs to (projection) + * stringringtone_path Ringtone path that the number belongs to (projection) + * stringimage_thumbnail_path Image thumbnail path that the number belongs to (projection) * integer number_id DB record ID of the number * integer type Number type, refer to the @ref contacts_number_type_e (projection) * string label Custom number type label, when the number type is #CONTACTS_NUMBER_TYPE_CUSTOM (projection) @@ -1588,6 +1616,7 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_FILTER_STR(cleaned_number) _CONTACTS_END_READ_ONLY_VIEW(_contacts_contact_number) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact_email _contacts_contact_email view (read only) @@ -1606,7 +1635,7 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_contact_number) * stringringtone_path Ringtone path that the email belongs to (projection) * stringimage_thumbnail_path Image thumbnail path that the email belongs to (projection) * integer email_id DB record ID of the email - * integer type Email type, refer to the @ref contacts_email_type_e (projection) + * integer type Email type, refer to the @ref contacts_email_type_e (projection) * string label Custom mail type label, when the email type is #CONTACTS_EMAIL_TYPE_CUSTOM (projection) * boolean is_default Email is default email or not * string email Email address @@ -1627,6 +1656,7 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_STR(email) _CONTACTS_END_READ_ONLY_VIEW(_contacts_contact_email) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact_grouprel _contacts_contact_grouprel view (read only) @@ -1660,6 +1690,7 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_PROJECTION_STR(group_name) _CONTACTS_END_READ_ONLY_VIEW(_contacts_contact_grouprel) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact_activity _contacts_contact_activity view (read only) @@ -1702,6 +1733,7 @@ _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_STR(uri) _CONTACTS_END_READ_ONLY_VIEW(_contacts_contact_activity) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_phone_log_stat _contacts_phone_log_stat view (read only) @@ -1720,9 +1752,10 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_contact_activity) _CONTACTS_BEGIN_READ_ONLY_VIEW() _CONTACTS_PROPERTY_PROJECTION_INT(log_count) _CONTACTS_PROPERTY_INT(log_type) - _CONTACTS_PROPERTY_INT(sim_slot_no) /*(Since 3.0)*/ + _CONTACTS_PROPERTY_INT(sim_slot_no) /*(Since 3.0)*/ _CONTACTS_END_READ_ONLY_VIEW(_contacts_phone_log_stat) + /** * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE View/Property * @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_sip _contacts_sip view (Since 3.0) @@ -1741,17 +1774,19 @@ _CONTACTS_END_READ_ONLY_VIEW(_contacts_phone_log_stat) * string label read, write Custom sip type label, when the sip type is #CONTACTS_SIP_TYPE_CUSTOM * */ -_CONTACTS_BEGIN_VIEW() /* (Since 3.0) */ - _CONTACTS_PROPERTY_INT(id) /* read only */ - _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ - _CONTACTS_PROPERTY_STR(address) /* read, write */ - _CONTACTS_PROPERTY_INT(type) /* read, write */ - _CONTACTS_PROPERTY_STR(label) /* read, write */ +_CONTACTS_BEGIN_VIEW() /* (Since 3.0) */ + _CONTACTS_PROPERTY_INT(id) /* read only */ + _CONTACTS_PROPERTY_INT(contact_id) /* read, write once */ + _CONTACTS_PROPERTY_STR(address) /* read, write */ + _CONTACTS_PROPERTY_INT(type) /* read, write */ + _CONTACTS_PROPERTY_STR(label) /* read, write */ _CONTACTS_END_VIEW(_contacts_sip) + #ifdef __cplusplus } #endif + #endif /* __TIZEN_SOCIAL_CONTACTS_VIEWS_H__ */ -- 2.7.4