*
* @section CAPI_UIX_STICKER_MODULE_FEATURE Related Feature
* This API is related with the following feature:\n
- * - http://tizen.org/feature/ui_service.sticker
+ * - %http://tizen.org/feature/ui_service.sticker
*
* 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
* @param[out] consumer_handle The sticker consumer handle
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
- * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_consumer_destroy()
*/
int sticker_consumer_create(sticker_consumer_h *consumer_handle);
* @param[in] consumer_handle The sticker consumer handle
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_consumer_create()
*/
int sticker_consumer_destroy(sticker_consumer_h consumer_handle);
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @post This function invokes sticker_consumer_data_foreach_cb() repeatedly for getting data.
* @see sticker_consumer_data_foreach_cb()
*/
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @post This function invokes sticker_consumer_data_foreach_cb() repeatedly for getting data.
* @see sticker_consumer_data_foreach_cb()
*/
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @post This function invokes sticker_consumer_data_foreach_cb() repeatedly for getting data.
* @see sticker_consumer_data_foreach_cb()
*/
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @post This function invokes sticker_consumer_data_foreach_cb() repeatedly for getting data.
* @see sticker_consumer_data_foreach_cb()
*/
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @post This function invokes sticker_consumer_group_list_foreach_cb() repeatedly for getting data.
* @see sticker_consumer_group_list_foreach_cb()
*/
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @post This function invokes sticker_consumer_keyword_list_foreach_cb() repeatedly for getting data.
* @see sticker_consumer_keyword_list_foreach_cb()
*/
* @param[out] data_handle The sticker data handle
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_data_destroy()
*/
int sticker_data_create(sticker_data_h *data_handle);
* @param[in] data_handle The sticker data handle
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
- * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @see sticker_data_create()
*/
int sticker_data_destroy(sticker_data_h data_handle);
* @param[out] target_handle The sticker data handle to be cloned
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_data_destroy()
*/
int sticker_data_clone(sticker_data_h origin_handle, sticker_data_h *target_handle);
* @param[out] app_id The name of the application that provides sticker information
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
*/
int sticker_data_get_app_id(sticker_data_h data_handle, char **app_id);
* @param[in] uri The URI to be saved
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_data_get_uri()
*/
int sticker_data_set_uri(sticker_data_h data_handle, sticker_data_uri_type_e type, const char *uri);
* @param[out] uri The URI
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_data_set_uri()
*/
int sticker_data_get_uri(sticker_data_h data_handle, sticker_data_uri_type_e *type, char **uri);
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @post This function invokes sticker_data_keyword_foreach_cb() repeatedly for getting keywords.
* @see sticker_data_keyword_foreach_cb()
* @see sticker_data_add_keyword()
* @param[in] keyword The keyword to be saved
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
- * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @see sticker_data_keyword_foreach_cb()
* @see sticker_data_foreach_keyword()
* @see sticker_data_remove_keyword()
* @param[in] keyword The keyword to be removed
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
- * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @see sticker_data_keyword_foreach_cb()
* @see sticker_data_foreach_keyword()
* @see sticker_data_add_keyword()
* @param[in] group The group name to be saved
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
- * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @see sticker_data_get_group()
*/
int sticker_data_set_group_name(sticker_data_h data_handle, const char *group);
* @param[out] group The group name
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_data_set_group()
*/
int sticker_data_get_group_name(sticker_data_h data_handle, char **group);
* @param[in] thumbnail The thumbnail path to be saved
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
- * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @see sticker_data_get_thumbnail()
*/
int sticker_data_set_thumbnail(sticker_data_h data_handle, const char *thumbnail);
* @param[out] thumbnail The thumbnail path
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
- * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @see sticker_data_set_thumbnail()
*/
int sticker_data_get_thumbnail(sticker_data_h data_handle, char **thumbnail);
* @param[in] description The description to be saved
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
- * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @see sticker_data_get_description()
*/
int sticker_data_set_description(sticker_data_h data_handle, const char *description);
* @param[out] description The description of the sticker
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
- * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @see sticker_data_set_description()
*/
int sticker_data_get_description(sticker_data_h data_handle, char **description);
* @param[out] date The last updated date
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
*/
int sticker_data_get_date(sticker_data_h data_handle, char **date);
*/
typedef enum {
STICKER_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
- STICKER_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
+ STICKER_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */
STICKER_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
+ STICKER_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
STICKER_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
- STICKER_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */
STICKER_ERROR_OPERATION_FAILED = TIZEN_ERROR_STICKER | 0x0001, /**< Operation failed */
} sticker_error_e;
* @param[out] provider_handle The sticker provider handle
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_provider_destroy()
*/
int sticker_provider_create(sticker_provider_h *provider_handle);
* @param[in] provider_handle The sticker provider handle
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_provider_create()
*/
int sticker_provider_destroy(sticker_provider_h provider_handle);
* @brief Inserts a sticker data to the sticker database.
* @since_tizen 5.5
* @remarks All data except thumbnail and description must be set in the @a data_handle to insert the sticker data.
- * If the uri type is @a STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
+ * If the uri type is #STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
* It is recommended to delete your sticker file after inserting a sticker data.
* @param[in] provider_handle The sticker provider handle
* @param[in] data_handle The sticker data handle to be saved
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_provider_update_data()
* @see sticker_provider_delete_data()
*/
* @since_tizen 5.5
* @remarks All data except thumbnail and description must be set in the json file to insert the sticker data.
* @a json_path must have a non-null value and must be an existing file. If not, the error as invalid parameter will be returned.
- * If the uri type is @a STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
+ * If the uri type is #STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
* It is recommended to delete your sticker files after inserting a sticker data.
* @param[in] provider_handle The sticker provider handle
* @param[in] json_path The path of json file containing sticker information to be saved
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @post This function invokes sticker_provider_insert_finished_cb().
* @see sticker_provider_insert_finished_cb()
*
* @param[in] data_handle The sticker data handle to be updated
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_provider_insert_data()
* @see sticker_provider_delete_data()
*/
/**
* @brief Deletes a sticker data in the sticker database.
* @since_tizen 5.5
- * @remarks The @a sticker_id must be the ID of the sticker stored in the sticker database.
+ * @remarks The @a data_handle must be the handle of the sticker stored in the sticker database.
* @param[in] provider_handle The sticker provider handle
* @param[in] data_handle The sticker data handle to be deleted
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @see sticker_provider_insert_data()
* @see sticker_provider_update_data()
*/
* @param[out] count The number of stickers
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
*/
int sticker_provider_get_sticker_count(sticker_provider_h provider_handle, int *count);
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #STICKER_ERROR_NONE Successful
+ * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @post This function invokes sticker_provider_data_foreach_cb() repeatedly for getting data.
* @see sticker_provider_data_foreach_cb()
*/