include/sticker_provider.h

   1 /*
   2  * Copyright (c) 2018 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __TIZEN_UIX_STICKER_PROVIDER_H__
  18 #define __TIZEN_UIX_STICKER_PROVIDER_H__
  19
  20 #include <sticker_error.h>
  21 #include <sticker_data.h>
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 /**
  28  * @file sticker_provider.h
  29  * @brief This file contains sticker provider's APIs.
  30  */
  31
  32 /**
  33  * @addtogroup CAPI_UIX_STICKER_PROVIDER_MODULE
  34  * @{
  35  */
  36
  37 /**
  38  * @brief The sticker provider handle.
  39  * @since_tizen 5.5
  40  */
  41 typedef struct sticker_provider_s *sticker_provider_h;
  42
  43 /**
  44  * @brief Called to retrieve all sticker data in the sticker database.
  45  * @details The sticker_provider_data_foreach_all() must be called to invoke this callback function, synchronously.
  46  * @since_tizen 5.5
  47  * @remarks @a data_handle should not be freed and can be used only in the callback.
  48  *          If you want to use it outside of the callback, you need to use a clone which can be obtained sticker_data_clone().
  49  * @param[in] data_handle The sticker data handle
  50  * @param[in] user_data The user data passed from the foreach function
  51  * @pre sticker_provider_data_foreach_all() will invoke this callback.
  52  * @see sticker_provider_data_foreach_all()
  53  */
  54 typedef void (*sticker_provider_data_foreach_cb)(sticker_data_h data_handle, void *user_data);
  55
  56 /**
  57  * @brief Called when inserting sticker data is finished.
  58  * @details The following error codes can be received: \n
  59  *          #STICKER_ERROR_NONE                 Successful \n
  60  *          #STICKER_ERROR_OPERATION_FAILED     Operation failed \n
  61  * @since_tizen 5.5
  62  * @param[in] error The sticker error code
  63  * @param[in] user_data The user data passed from the foreach function
  64  * @pre sticker_privider_insert_data_by_json_file() will invoke this callback.
  65  * @see sticker_privider_insert_data_by_json_file()
  66  */
  67 typedef void (*sticker_provider_insert_finished_cb)(sticker_error_e error, void *user_data);
  68
  69 /**
  70  * @brief Creates a sticker provider handle.
  71  * @since_tizen 5.5
  72  * @remarks If the function succeeds, @a provider_handle must be released with sticker_provider_destroy().
  73  * @param[out] provider_handle The sticker provider handle
  74  * @return 0 on success, otherwise a negative error value
  75  * @retval #STICKER_ERROR_NONE Successful
  76  * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
  77  * @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
  78  * @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
  79  * @see sticker_provider_destroy()
  80  */
  81 int sticker_provider_create(sticker_provider_h *provider_handle);
  82
  83 /**
  84  * @brief Destroys a sticker provider handle.
  85  * @since_tizen 5.5
  86  * @param[in] provider_handle The sticker provider handle
  87  * @return 0 on success, otherwise a negative error value
  88  * @retval #STICKER_ERROR_NONE Successful
  89  * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
  90  * @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
  91  * @see sticker_provider_create()
  92  */
  93 int sticker_provider_destroy(sticker_provider_h provider_handle);
  94
  95 /**
  96  * @brief Inserts a sticker data to the sticker database.
  97  * @since_tizen 5.5
  98  * @remarks All data except thumbnail and description must be set in the @a data_handle to insert the sticker data.
  99  *          If the uri type is @a STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
 100  *          It is recommended to delete your sticker file after inserting a sticker data.
 101  * @param[in] provider_handle The sticker provider handle
 102  * @param[in] data_handle The sticker data handle to be saved
 103  * @return 0 on success, otherwise a negative error value
 104  * @retval #STICKER_ERROR_NONE Successful
 105  * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
 106  * @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
 107  * @see sticker_provider_update_data()
 108  * @see sticker_provider_delete_data()
 109  */
 110 int sticker_provider_insert_data(sticker_provider_h provider_handle, sticker_data_h data_handle);
 111
 112 /**
 113  * @brief Inserts a sticker data using json file.
 114  * @details @a json_path must be a relative path like '/data/message_sticker.json'.
 115  * @since_tizen 5.5
 116  * @remarks All data except thumbnail and description must be set in the json file to insert the sticker data.
 117  *          @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.
 118  *          If the uri type is @a STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
 119  *          It is recommended to delete your sticker files after inserting a sticker data.
 120  * @param[in] provider_handle The sticker provider handle
 121  * @param[in] json_path The path of json file containing sticker information to be saved
 122  * @param[in] callback The callback function to invoke
 123  * @param[in] user_data The user data to be passed to the callback function
 124  * @return 0 on success, otherwise a negative error value
 125  * @retval #STICKER_ERROR_NONE Successful
 126  * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
 127  * @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
 128  * @post This function invokes sticker_provider_insert_finished_cb().
 129  * @see sticker_provider_insert_finished_cb()
 130  *
 131  * @code
 132  //json file format
 133  {
 134     "sticker":
 135     [
 136         {
 137             "type" : 1,
 138             "uri" : "/res/face/heart_eyes.png",
 139             "keyword" : ["heart eyes", "love", "cute"],
 140             "group" : "face",
 141             "thumbnail" : "/res/face/thumbnail/heart_eyes.png",
 142             "description" : "Smiling face with heart eyes emoji."
 143         },
 144         {
 145             "type" : 2,
 146             "uri" : "https://samsung.com/example/01/high_five.png",
 147             "keyword" : ["smile", "high five"],
 148             "group" : "face",
 149             "thumbnail" : "",
 150             "description" : "Smiling face with high five emoji."
 151         },
 152             .....
 153         {
 154             .....
 155         }
 156     ]
 157  }
 158  * @endcode
 159  */
 160 int sticker_privider_insert_data_by_json_file(sticker_provider_h provider_handle, const char *json_path, sticker_provider_insert_finished_cb callback, void *user_data);
 161
 162 /**
 163  * @brief Updates a sticker data in the sticker database.
 164  * @since_tizen 5.5
 165  * @param[in] provider_handle The sticker provider handle
 166  * @param[in] data_handle The sticker data handle to be updated
 167  * @return 0 on success, otherwise a negative error value
 168  * @retval #STICKER_ERROR_NONE Successful
 169  * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
 170  * @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
 171  * @see sticker_provider_insert_data()
 172  * @see sticker_provider_delete_data()
 173  */
 174 int sticker_provider_update_data(sticker_provider_h provider_handle, sticker_data_h data_handle);
 175
 176 /**
 177  * @brief Deletes a sticker data in the sticker database.
 178  * @since_tizen 5.5
 179  * @remarks The @a sticker_id must be the ID of the sticker stored in the sticker database.
 180  * @param[in] provider_handle The sticker provider handle
 181  * @param[in] data_handle The sticker data handle to be deleted
 182  * @return 0 on success, otherwise a negative error value
 183  * @retval #STICKER_ERROR_NONE Successful
 184  * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
 185  * @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
 186  * @see sticker_provider_insert_data()
 187  * @see sticker_provider_update_data()
 188  */
 189 int sticker_provider_delete_data(sticker_provider_h provider_handle, sticker_data_h data_handle);
 190
 191 /**
 192  * @brief Gets the count of stickers stored by the provider application.
 193  * @since_tizen 5.5
 194  * @param[in] provider_handle The sticker provider handle
 195  * @param[out] count The number of stickers
 196  * @return 0 on success, otherwise a negative error value
 197  * @retval #STICKER_ERROR_NONE Successful
 198  * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
 199  * @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
 200  */
 201 int sticker_provider_get_sticker_count(sticker_provider_h provider_handle, int *count);
 202
 203 /**
 204  * @brief Retrieves all sticker data in the sticker database.
 205  * @details If you set the @a offset as @c 10 and @a count as @c 10, then only searched data from @c 10 to @c 19 will be invoked.
 206  * @since_tizen 5.5
 207  * @remarks It is not an error if @a result is smaller than @a count.
 208  * @param[in] provider_handle The sticker provider handle
 209  * @param[in] offset The start position (Starting from zero)
 210  * @param[in] count The number of stickers to be searched with respect to the offset
 211  * @param[out] result The number of stickers retrieved (zero indicates that no data was found)
 212  * @param[in] callback The callback function to invoke
 213  * @param[in] user_data The user data to be passed to the callback function
 214  * @return 0 on success, otherwise a negative error value
 215  * @retval #STICKER_ERROR_NONE Successful
 216  * @retval #STICKER_ERROR_INVALID_PARAMETER Invalid parameter
 217  * @retval #STICKER_ERROR_OUT_OF_MEMORY Out of memory
 218  * @retval #STICKER_ERROR_OPERATION_FAILED Operation failed
 219  * @post This function invokes sticker_provider_data_foreach_cb() repeatedly for getting data.
 220  * @see sticker_provider_data_foreach_cb()
 221  */
 222 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);
 223
 224 /**
 225  * @}
 226  */
 227
 228 #ifdef __cplusplus
 229 }
 230 #endif
 231
 232 #endif /* __TIZEN_UIX_STICKER_PROVIDER_H__ */