Tizen Native API
|
The contacts setting API provides the set of definitions and interfaces that enable application developers to set up contacts features.
Required Header
#include <contacts.h>
Typedef Documentation
typedef void(* contacts_setting_name_display_order_changed_cb)(contacts_name_display_order_e name_display_order, void *user_data) |
Called when a designated view changes.
- Since :
- 2.3
- Parameters:
-
[in] name_display_order The name display order setting value [in] user_data The user data passed from the callback registration function
- Precondition:
- 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.
typedef void(* contacts_setting_name_sorting_order_changed_cb)(contacts_name_sorting_order_e name_sorting_order, void *user_data) |
Called when a designated view changes.
- Since :
- 2.3
- Parameters:
-
[in] name_sorting_order The name sorting order setting value [in] user_data The user data passed from the callback registration function
- Precondition:
- 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.
Enumeration Type Documentation
Function Documentation
int contacts_setting_add_name_display_order_changed_cb | ( | contacts_setting_name_display_order_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/contact.read
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
CONTACTS_ERROR_NONE Successful CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter CONTACTS_ERROR_IPC Unknown IPC error CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method.
- Precondition:
- contacts_connect() should be called to open a connection to the contacts service.
- Postcondition:
- contacts_setting_name_display_order_changed_cb() will be called under certain conditions, after calling contacts_setting_set_name_display_order().
int contacts_setting_add_name_sorting_order_changed_cb | ( | contacts_setting_name_sorting_order_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/contact.read
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
CONTACTS_ERROR_NONE Successful CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter CONTACTS_ERROR_IPC Unknown IPC error CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method.
- Precondition:
- contacts_connect() should be called to open a connection to the contacts service.
- Postcondition:
- contacts_setting_name_sorting_order_changed_cb() will be called under certain conditions, after calling contacts_setting_set_name_sorting_order().
int contacts_setting_get_name_display_order | ( | contacts_name_display_order_e * | name_display_order | ) |
Gets the contacts name display order.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/contact.read
- Parameters:
-
[out] name_display_order The name display order
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
CONTACTS_ERROR_NONE Successful CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. CONTACTS_ERROR_IPC Unknown IPC error CONTACTS_ERROR_SYSTEM Internal system module error
- Precondition:
- contacts_connect() should be called to open a connection to the contacts service.
- See also:
- contacts_connect()
int contacts_setting_get_name_sorting_order | ( | contacts_name_sorting_order_e * | name_sorting_order | ) |
Gets the contacts name sorting order in which contacts are returned.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/contact.read
- Parameters:
-
[out] name_sorting_order The name sorting order
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
CONTACTS_ERROR_NONE Successful CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. CONTACTS_ERROR_IPC Unknown IPC error CONTACTS_ERROR_SYSTEM Internal system module error
- Precondition:
- contacts_connect() should be called to open a connection to the contacts service.
- See also:
- contacts_connect()
int contacts_setting_remove_name_display_order_changed_cb | ( | contacts_setting_name_display_order_changed_cb | callback, |
void * | user_data | ||
) |
Unregisters a callback function.
- Since :
- 2.3
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
CONTACTS_ERROR_NONE Successful CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use
- Precondition:
- contacts_connect() should be called to open a connection to the contacts service.
int contacts_setting_remove_name_sorting_order_changed_cb | ( | contacts_setting_name_sorting_order_changed_cb | callback, |
void * | user_data | ||
) |
Unregisters a callback function.
- Since :
- 2.3
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
CONTACTS_ERROR_NONE Successful CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter CONTACTS_ERROR_INTERNAL Implementation Error, Temporary Use
- Precondition:
- contacts_connect() should be called to open a connection to the contacts service.
int contacts_setting_set_name_display_order | ( | contacts_name_display_order_e | name_display_order | ) |
Sets the contacts name display order.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/contact.write
- Parameters:
-
[in] name_display_order The name display order
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
CONTACTS_ERROR_NONE Successful CONTACTS_ERROR_OUT_OF_MEMORY Out of memory CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. CONTACTS_ERROR_IPC Unknown IPC error CONTACTS_ERROR_SYSTEM Internal system module error
- Precondition:
- contacts_connect() should be called to open a connection to the contacts service.
- Postcondition:
- contacts_setting_name_display_order_changed_cb() callback will be called upon success.
- See also:
- contacts_connect()
int contacts_setting_set_name_sorting_order | ( | contacts_name_sorting_order_e | name_sorting_order | ) |
Sets the contacts name sorting order in which contacts are returned.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/contact.write
- Parameters:
-
[in] name_sorting_order The name sorting order
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
CONTACTS_ERROR_NONE Successful CONTACTS_ERROR_OUT_OF_MEMORY Out of memory CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter CONTACTS_ERROR_PERMISSION_DENIED Permission denied. This application does not have the privilege to call this method. CONTACTS_ERROR_IPC Unknown IPC error CONTACTS_ERROR_SYSTEM Internal system module error
- Precondition:
- contacts_connect() should be called to open a connection to the contacts service.
- Postcondition:
- contacts_setting_name_sorting_order_changed_cb() callback will be called upon success.
- See also:
- contacts_connect()