* @{
*/
-
/**
* @brief Deletes an activity record from the contacts database by contact ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
* limitations under the License.
*
*/
+
+
#ifndef __TIZEN_SOCIAL_CONTACTS_DB_H__
#define __TIZEN_SOCIAL_CONTACTS_DB_H__
* @file contacts_db.h
*/
-
/**
* @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE
* @defgroup CAPI_SOCIAL_CONTACTS_SVC_DATABASE_MODULE Database
* @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.
+ * %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
* @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
+ * 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,
* @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
+ * 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
* @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 Enumeration for contact DB status.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
- *
*/
typedef enum {
CONTACTS_DB_STATUS_NORMAL, /**< Normal */
* @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()
+ * @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);
* 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);
* limitations under the License.
*
*/
-
-
+
#ifndef __TIZEN_SOCIAL_CONTACTS_LIST_H__
#define __TIZEN_SOCIAL_CONTACTS_LIST_H__
* @file contacts_list.h
*/
-
+
/**
* @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE
* @defgroup CAPI_SOCIAL_CONTACTS_SVC_LIST_MODULE List
* 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);
*/
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
* @}
*/
-
+
#ifdef __cplusplus
}
#endif
* @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.
+ * @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
*/
int contacts_person_get_aggregation_suggestions(int person_id, int limit, contacts_list_h *record_list);
+
/**
* @}
*/
/**
- * @brief Resets the phone log's count.
+ * @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
/**
- * @brief Resets the phone log's count by sim slot no.
+ * @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_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()
+ * @see contacts_connect()
*/
int contacts_phone_log_reset_statistics_by_sim(int sim_slot_no);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* limitations under the License.
*
*/
+
+
#ifndef __TIZEN_SOCIAL_CONTACTS_SETTING_H__
#define __TIZEN_SOCIAL_CONTACTS_SETTING_H__
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
* @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
+ * @param[in] name_display_order The name display order
* @return @c 0 on success,
* otherwise a negative error value
* @retval #CONTACTS_ERROR_NONE Successful
/**
* @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;
*/
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
* @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_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
+ * @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()
/**
* @}
*/
-
+
#ifdef __cplusplus
}
/**
* @brief Enumeration for Contact address type.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
- *
*/
typedef enum {
CONTACTS_ADDRESS_TYPE_OTHER, /**< Other address type */
CONTACTS_EVENT_CALENDAR_TYPE_CHINESE /**< Chinese calenadr */
} contacts_event_calendar_type_e;
-
/**
- * @brief Enumeration for Contact image type
+ * @brief Enumeration for Contact image type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
*
*/
/**
- * @brief Enumeration for SIP(Session Intialion Protocol) type range
+ * @brief Enumeration for SIP(Session Intialion Protocol) type range.
* @since_tizen 3.0
*/
typedef enum {
* <tr><td>string</td><td> message_alert </td><td>read, write</td><td> Message alert path of the person </td></tr>
* <tr><td>string</td><td> status </td><td>read only</td><td> Status of social account </td></tr>
* <tr><td>boolean</td><td> is_favorite </td><td>read, write</td><td> The person is favorite or not </td></tr>
- * <tr><td>double</td><td> favorite_priority </td><td> sort only </td><td> 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 </td></tr>
+ * <tr><td>double</td><td> favorite_priority </td><td> read only </td><td> 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 </td></tr>
* <tr><td>integer</td><td> link_count </td><td>read only</td><td> Link count of contact records (projection) </td></tr>
* <tr><td>string</td><td> addressbook_ids </td><td>read only</td><td> Addressbook IDs that the person belongs to (projection) </td></tr>
* <tr><td>boolean</td><td> has_phonenumber </td><td>read only</td><td> The person has phone number or not </td></tr>
_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_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 */
* @section CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_contact _contacts_contact view
* <table>
* <tr>
- * <th>Type</th>
+ * <th>Type</th>
* <th>Property ID</th>
* <th>Read, Write</th>
* <th>Description</th>
_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)
* limitations under the License.
*
*/
+
+
#ifndef __TIZEN_SOCIAL_CONTACTS_SIM_H__
#define __TIZEN_SOCIAL_CONTACTS_SIM_H__
+
#include <tizen.h>
+
#ifdef __cplusplus
extern "C"
{
#endif
+
/**
* @file contacts_sim.h
*/
+
/**
* @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE
* @defgroup CAPI_SOCIAL_CONTACTS_SVC_SIM_MODULE SIM
- *
* @brief The contacts SIM API provides the set of definitions and interfaces that enable application developers to get/set data from/to SIM card.
- *
* @section CAPI_SOCIAL_CONTACTS_SVC_SIM_MODULE_HEADER Required Header
- * \#include <contacts.h>
- *
+ * \#include <contacts.h>
* @section CAPI_SOCIAL_CONTACTS_SVC_SIM_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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
+ * 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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
* <BR>
* @{
*/
+
/**
* @deprecated Deprecated since 3.0. Use contacts_sim_import_all_contacts_by_sim_slot_no() instead.
- * @brief Imports all contacts from first SIM to the Contacts Database.
- *
+ * @brief Imports all contacts from first SIM to Contacts Database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
- *
- * @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
- * @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_IPC Unknown IPC error
- * @retval #CONTACTS_ERROR_SYSTEM Internal system module error
- * @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()
+ * @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
+ * @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_IPC Unknown IPC error
+ * @retval #CONTACTS_ERROR_SYSTEM Internal system module error
+ * @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()
*/
int contacts_sim_import_all_contacts(void) TIZEN_DEPRECATED_API;
/**
* @deprecated Deprecated since 3.0. Use contacts_sim_get_initialization_status_by_sim_slot_no() instead.
* @brief Checks whether first SIM initialization is completed.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
- *
- * @param[out] completed @c true if SIM is initialized,
- * otherwise @c false if SIM is not initialized
- *
- * @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_NOT_SUPPORTED Not supported
- * @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()
+ * @param[out] completed @c true if SIM is initialized,
+ * otherwise @c false if SIM is not initialized
+ * @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_NOT_SUPPORTED Not supported
+ * @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_sim_get_initialization_status(bool *completed) TIZEN_DEPRECATED_API;
+
/**
* @brief Called whenever a contact is imported.
- *
* @since_tizen 3.0
- *
- * @param[in] total The number of contacts that will be imported
- * @param[in] imported_cnt The number of already imported contacts
- * @param[in] user_data The user data passed from the callback registration function
- *
- * @return @c true to continue with the import of contacts
- * otherwise @c false to stop the import of contacts
- *
+ * @param[in] total The number of contacts that will be imported
+ * @param[in] imported_cnt The number of already imported contacts
+ * @param[in] user_data The user data passed from the callback registration function
+ * @return @c true to continue with the import of contacts
+ * otherwise @c false to stop the import of contacts
* @pre contacts_sim_import_all_contacts_by_sim_slot_no() will invoke this callback.
- *
* @see contacts_sim_import_all_contacts_by_sim_slot_no()
*/
typedef bool (*contacts_sim_import_progress_cb)(int total, int imported_cnt, void *user_data);
+
/**
* @brief Imports all contacts from SIM of the given SIM slot number to the Contacts Database.
- *
* @details This function invokes contacts_sim_import_progress_cb() to indicate the progress of imports whenever a contact is imported.
- *
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
- *
- * @param[in] sim_slot_no The SIM slot number; 0 means first SIM, 1 means second SIM
- * @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_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_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()
- * @see contacts_sim_import_progress_cb()
+ * @param[in] sim_slot_no The SIM slot number; 0 means first SIM, 1 means second SIM
+ * @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_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_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()
+ * @see contacts_sim_import_progress_cb()
*/
-
int contacts_sim_import_all_contacts_by_sim_slot_no(int sim_slot_no, contacts_sim_import_progress_cb callback, void *user_data);
+
/**
* @brief Checks whether SIM of the given SIM slot number is initialized.
- *
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
- *
- * @param[in] sim_slot_no The SIM slot number; 0 means first SIM, 1 means second SIM
- * @param[out] completed @c true if SIM is initialized,
- * otherwise @c false if SIM is not initialized
- *
- * @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_NOT_SUPPORTED Not supported
- * @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()
+ * @param[in] sim_slot_no The SIM slot number; 0 means first SIM, 1 means second SIM
+ * @param[out] completed @c true if SIM is initialized,
+ * otherwise @c false if SIM is not initialized
+ * @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_NOT_SUPPORTED Not supported
+ * @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_sim_get_initialization_status_by_sim_slot_no(int sim_slot_no, bool *completed);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif /* __TIZEN_SOCIAL_CONTACTS_SIM_H__ */
* limitations under the License.
*
*/
+
+
#ifndef __TIZEN_SOCIAL_CONTACTS_SIM_H__
#define __TIZEN_SOCIAL_CONTACTS_SIM_H__
+#include <tizen.h>
+
+
#ifdef __cplusplus
extern "C"
{
#endif
+
/**
* @file contacts_sim.h
*/
+
/**
* @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE
* @defgroup CAPI_SOCIAL_CONTACTS_SVC_SIM_MODULE SIM
- *
* @brief The contacts SIM API provides the set of definitions and interfaces that enable application developers to get/set data from/to SIM card.
- *
* @section CAPI_SOCIAL_CONTACTS_SVC_SIM_MODULE_HEADER Required Header
- * \#include <contacts.h>
- *
+ * \#include <contacts.h>
* @section CAPI_SOCIAL_CONTACTS_SVC_SIM_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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
+ * 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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
* <BR>
* @{
*/
/**
* @brief Called whenever a contact is imported.
- *
* @since_tizen 3.0
- *
- * @param[in] total The number of contacts that will be imported
- * @param[in] imported_cnt The number of already imported contacts
- * @param[in] user_data The user data passed from the callback registration function
- *
- * @return @c true to continue with the import of contacts
- * otherwise @c false to stop the import of contacts
- *
+ * @param[in] total The number of contacts that will be imported
+ * @param[in] imported_cnt The number of already imported contacts
+ * @param[in] user_data The user data passed from the callback registration function
+ * @return @c true to continue with the import of contacts
+ * otherwise @c false to stop the import of contacts
* @pre contacts_sim_import_all_contacts_by_sim_slot_no() will invoke this callback.
- *
* @see contacts_sim_import_all_contacts_by_sim_slot_no()
*/
typedef bool (*contacts_sim_import_progress_cb)(int total, int imported_cnt, void *user_data);
+
/**
* @brief Imports all contacts from SIM of the given SIM slot number to the Contacts Database.
- *
* @details This function invokes contacts_sim_import_progress_cb() to indicate the progress of imports whenever a contact is imported.
- *
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
- *
- * @param[in] sim_slot_no The SIM slot number; 0 means first SIM, 1 means second SIM
- * @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_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_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()
- * @see contacts_sim_import_progress_cb()
+ * @param[in] sim_slot_no The SIM slot number; 0 means first SIM, 1 means second SIM
+ * @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_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_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()
+ * @see contacts_sim_import_progress_cb()
*/
-
int contacts_sim_import_all_contacts_by_sim_slot_no(int sim_slot_no, contacts_sim_import_progress_cb callback, void *user_data);
+
/**
* @brief Checks whether SIM of the given SIM slot number is initialized.
- *
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
- *
- * @param[in] sim_slot_no The SIM slot number; 0 means first SIM, 1 means second SIM
- * @param[out] completed @c true if SIM is initialized,
- * otherwise @c false if SIM is not initialized
- *
- * @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_NOT_SUPPORTED Not supported
- * @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()
+ * @param[in] sim_slot_no The SIM slot number; 0 means first SIM, 1 means second SIM
+ * @param[out] completed @c true if SIM is initialized,
+ * otherwise @c false if SIM is not initialized
+ * @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_NOT_SUPPORTED Not supported
+ * @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_sim_get_initialization_status_by_sim_slot_no(int sim_slot_no, bool *completed);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
+
#endif /* __TIZEN_SOCIAL_CONTACTS_SIM_H__ */
projects / platform / core / pim / contacts-service.git / commitdiff