* @since_tizen 5.5
*/
typedef enum {
- STICKER_CONSUMER_EVENT_TYPE_INSERT, /**< Insert event type */
- STICKER_CONSUMER_EVENT_TYPE_DELETE, /**< Delete event type */
- STICKER_CONSUMER_EVENT_TYPE_UPDATE, /**< Update event type */
+ STICKER_CONSUMER_EVENT_TYPE_INSERT, /**< A sticker data has been added */
+ STICKER_CONSUMER_EVENT_TYPE_DELETE, /**< A sticker data has been removed */
+ STICKER_CONSUMER_EVENT_TYPE_UPDATE, /**< A sticker data has been updated */
} sticker_consumer_event_type_e;
/**
* @since_tizen 5.5
* @remarks @a data_handle should not be freed and can be used only in the callback.
* If you want to use it outside of the callback, you need to use a clone which can be obtained sticker_data_clone().
- * When the @a event_type is STICKER_CONSUMER_EVENT_TYPE_DELETE, sticker data can be obtained using @a data_handle,
- * but unable to access file because it has been deleted.
- * @param[in] event_type The event type of sticker
+ * When the @a event_type is #STICKER_CONSUMER_EVENT_TYPE_DELETE, sticker data can be obtained using @a data_handle,
+ * but the files have been already deleted.
+ * @param[in] event_type The event type
* @param[in] data_handle The sticker data handle
- * @param[in] user_data The user data passed from sticker_consumer_set_event_callback()
- * @pre The callback can be registered using sticker_consumer_set_event_callback()
- * @see sticker_consumer_set_event_callback()
- * @see sticker_consumer_unset_event_callback()
+ * @param[in] user_data The user data passed from sticker_consumer_set_event_cb()
+ * @pre The callback can be registered using sticker_consumer_set_event_cb()
+ * @see sticker_consumer_set_event_cb()
+ * @see sticker_consumer_unset_event_cb()
*/
typedef void (*sticker_consumer_event_cb)(sticker_consumer_event_type_e event_type, sticker_data_h data_handle, void *user_data);
/**
+ * @brief Called to retrieve group images in the sticker database.
+ * @details The sticker_consumer_group_image_list_foreach_all() must be called to invoke this callback function, synchronously.
+ * @since_tizen 6.5
+ * @remarks @a group and @a uri should not be freed and can be used only in the callback.
+ * @param[in] group The group name of the stickers
+ * @param[in] type The URI type of the sticker group image URI
+ * @param[in] uri The URI of the sticker group image
+ * @param[in] user_data The user data passed from the foreach function
+ * @pre sticker_consumer_group_image_list_foreach_all() will invoke this callback.
+ * @see sticker_consumer_group_image_list_foreach_all()
+ */
+typedef void (*sticker_consumer_group_image_list_foreach_cb)(const char *group, sticker_data_uri_type_e type, const char *uri, void *user_data);
+
+/**
* @brief Creates a sticker consumer handle.
* @since_tizen 5.5
* @privlevel public
int sticker_consumer_data_foreach_by_display_type(sticker_consumer_h consumer_handle, int offset, int count, int *result, sticker_data_display_type_e type, sticker_consumer_data_foreach_cb callback, void *user_data);
/**
- * @brief Retrieves all group name in the sticker database using display type.
+ * @brief Retrieves all group names assigned to stickers with a matching display @a type.
* @since_tizen 5.5
* @param[in] consumer_handle The sticker consumer handle
* @param[in] type The display type of the sticker for getting sticker data
int sticker_consumer_group_list_foreach_by_display_type(sticker_consumer_h consumer_handle, sticker_data_display_type_e type, sticker_consumer_group_list_foreach_cb callback, void *user_data);
/**
- * @brief Add history to recently used stickers list
+ * @brief Adds entry to recently used stickers list.
* @since_tizen 5.5
* @param[in] consumer_handle The sticker consumer handle
* @param[in] data_handle The sticker data handle
* @retval #STICKER_ERROR_NOT_SUPPORTED Not supported
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
- * @see sticker_consumer_get_recent_list()
+ * @see sticker_consumer_get_recent_data_list()
*/
int sticker_consumer_add_recent_data(sticker_consumer_h consumer_handle, sticker_data_h data_handle);
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
* @see sticker_consumer_event_cb()
- * @see sticker_consumer_unset_event_callback()
+ * @see sticker_consumer_unset_event_cb()
*/
-int sticker_consumer_set_event_callback(sticker_consumer_h consumer_handle, sticker_consumer_event_cb callback, void *user_data);
+int sticker_consumer_set_event_cb(sticker_consumer_h consumer_handle, sticker_consumer_event_cb callback, void *user_data);
/**
* @brief Unregisters a callback function.
* @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
* @see sticker_consumer_event_cb()
- * @see sticker_consumer_set_event_callback()
+ * @see sticker_consumer_set_event_cb()
+ */
+int sticker_consumer_unset_event_cb(sticker_consumer_h consumer_handle);
+
+/**
+ * @brief Retrieves images of all sticker groups in the database.
+ * @since_tizen 6.5
+ * @param[in] consumer_handle The sticker consumer handle
+ * @param[in] callback The callback function to invoke
+ * @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
+ * @post This function invokes sticker_consumer_group_image_list_foreach_cb() repeatedly for getting data.
+ * @see sticker_consumer_group_image_list_foreach_cb()
*/
-int sticker_consumer_unset_event_callback(sticker_consumer_h consumer_handle);
+int sticker_consumer_group_image_list_foreach_all(sticker_consumer_h consumer_handle, sticker_consumer_group_image_list_foreach_cb callback, void *user_data);
/**
* @}
projects / platform / core / uifw / capi-ui-sticker.git / blobdiff