Add option to execute unittest in building package
[platform/core/uifw/capi-ui-sticker.git] / include / sticker_provider.h
index cdfbac4..9690781 100644 (file)
@@ -97,7 +97,7 @@ 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, description, display_type must be set in the @a data_handle to insert the sticker data.
+ * @remarks All data except thumbnail, description, and display_type must be set in the @a data_handle to insert the sticker data.
  *          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
@@ -118,7 +118,7 @@ int sticker_provider_insert_data(sticker_provider_h provider_handle, sticker_dat
  * @brief Inserts a sticker data using JSON file.
  * @details @a json_path must be a relative path like '/data/message_sticker.json'.
  * @since_tizen 5.5
- * @remarks All data except thumbnail, description, display_type must be set in the JSON file to insert the sticker data.
+ * @remarks All data except thumbnail, description, and display_type 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 #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.
@@ -201,8 +201,8 @@ int sticker_provider_update_data(sticker_provider_h provider_handle, sticker_dat
 int sticker_provider_delete_data(sticker_provider_h provider_handle, sticker_data_h data_handle);
 
 /**
- * @brief Deletes a sticker data with the given @a uri from the sticker database.
- * @details If the database does not have a sticker that matches the given @a uri, the STICKER_ERROR_NO_SUCH_FILE error is returned.
+ * @brief Deletes a sticker with the given @a uri from the sticker database.
+ * @details If the database does not have a sticker that matches the given @a uri, the #STICKER_ERROR_NO_SUCH_FILE error is returned.
  * @since_tizen 5.5
  * @param[in] provider_handle The sticker provider handle
  * @param[in] uri The URI of the sticker data to be deleted
@@ -253,6 +253,24 @@ int sticker_provider_get_sticker_count(sticker_provider_h provider_handle, int *
 int sticker_provider_data_foreach_all(sticker_provider_h provider_handle, int offset, int count, int *result, sticker_provider_data_foreach_cb callback, void *user_data);
 
 /**
+ * @brief Sets the image of the sticker group.
+ * @details @a uri must be a relative path like '/res/smile.png' when @a type is #STICKER_DATA_URI_LOCAL_PATH.
+ * @since_tizen 6.5
+ * @param[in] provider_handle The sticker provider handle
+ * @param[in] group The group name for setting group image
+ * @param[in] type The URI type of the image file
+ * @param[in] uri The URI of the image file
+ * @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, e.g. @a group is @c NULL or the group name does not exist in the database
+ * @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
+ * @retval #STICKER_ERROR_NO_SUCH_FILE No such file, e.g. @a uri is @c NULL or the specified file does not exist
+ * @see sticker_provider_insert_data()
+ */
+int sticker_provider_set_group_image(sticker_provider_h provider_handle, const char *group, sticker_data_uri_type_e type, const char *uri);
+
+/**
  * @}
  */