include/framework/event/oma_ds_event_handler.h

   1 /*
   2  * oma-ds-agent
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 /**
  19  *   @OMA_DS_Event_Handler.h
  20  *   @version                                                                   0.1
  21  *   @brief                                                                             This file is the header file of interface for event callback function(from UI)
  22  */
  23
  24 #ifndef OMA_DS_EVENT_HANDLER_H_
  25 #define OMA_DS_EVENT_HANDLER_H_
  26
  27 #include <stdio.h>
  28 #include <sync_agent.h>
  29
  30 /**
  31  * @par Description: This API is event callback function for add profile
  32  *
  33  *
  34  * @par Purpose:
  35  * @par Typical use case:
  36  * @par Method of function operation:
  37  * @par Important notes:
  38  * @param[in]           buffer for incomming parameter
  39  * @param[in]           buffer for outgoing parameter
  40  * @param[out]
  41  *
  42  * @return                              0 on success
  43  *
  44  * @par Errors:
  45  *
  46  * @pre None.
  47  * @post
  48  * @see
  49  * @remarks None.
  50  *
  51  * @par Sample Code:
  52  * @code
  53  * @endcode
  54  */
  55 int event_callback_add_profile_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
  56
  57 /**
  58  * @par Description: This API is event callback function for edit profile
  59  *
  60  *
  61  * @par Purpose:
  62  * @par Typical use case:
  63  * @par Method of function operation:
  64  * @par Important notes:
  65  * @param[in]           buffer for incomming parameter
  66  * @param[in]           buffer for outgoing parameter
  67  * @param[out]
  68  *
  69  * @return                              0 on success
  70  *
  71  * @par Errors:
  72  *
  73  * @pre None.
  74  * @post
  75  * @see
  76  * @remarks None.
  77  *
  78  * @par Sample Code:
  79  * @code
  80  * @endcode
  81  */
  82 int event_callback_edit_profile_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
  83
  84 /**
  85  * @par Description: This API is event callback function for delete profile
  86  *
  87  *
  88  * @par Purpose:
  89  * @par Typical use case:
  90  * @par Method of function operation:
  91  * @par Important notes:
  92  * @param[in]           buffer for incomming parameter
  93  * @param[in]           buffer for outgoing parameter
  94  * @param[out]
  95  *
  96  * @return                              0 on success
  97  *
  98  * @par Errors:
  99  *
 100  * @pre None.
 101  * @post
 102  * @see
 103  * @remarks None.
 104  *
 105  * @par Sample Code:
 106  * @code
 107  * @endcode
 108  */
 109 int event_callback_delete_profile_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 110
 111 /**
 112  * @par Description: This API is event callback function for request sync
 113  *
 114  *
 115  * @par Purpose:
 116  * @par Typical use case:
 117  * @par Method of function operation:
 118  * @par Important notes:
 119  * @param[in]           buffer for incomming parameter
 120  * @param[in]           buffer for outgoing parameter
 121  * @param[out]
 122  *
 123  * @return                              0 on success
 124  *
 125  * @par Errors:
 126  *
 127  * @pre None.
 128  * @post
 129  * @see
 130  * @remarks None.
 131  *
 132  * @par Sample Code:
 133  * @code
 134  * @endcode
 135  */
 136 int event_callback_request_sync_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 137
 138 /**
 139  * @par Description: This API is event callback function for cancel sync
 140  *
 141  *
 142  * @par Purpose:
 143  * @par Typical use case:
 144  * @par Method of function operation:
 145  * @par Important notes:
 146  * @param[in]           buffer for incomming parameter
 147  * @param[in]           buffer for outgoing parameter
 148  * @param[out]
 149  *
 150  * @return                              0 on success
 151  *
 152  * @par Errors:
 153  *
 154  * @pre None.
 155  * @post
 156  * @see
 157  * @remarks None.
 158  *
 159  * @par Sample Code:
 160  * @code
 161  * @endcode
 162  */
 163 int event_callback_cancel_sync_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 164
 165 /**
 166  * @par Description: This API is event callback function for get profile data
 167  *
 168  *
 169  * @par Purpose:
 170  * @par Typical use case:
 171  * @par Method of function operation:
 172  * @par Important notes:
 173  * @param[in]           buffer for incomming parameter
 174  * @param[in]           buffer for outgoing parameter
 175  * @param[out]
 176  *
 177  * @return                              0 on success
 178  *
 179  * @par Errors:
 180  *
 181  * @pre None.
 182  * @post
 183  * @see
 184  * @remarks None.
 185  *
 186  * @par Sample Code:
 187  * @code
 188  * @endcode
 189  */
 190 int event_callback_get_profile_data_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 191
 192 /**
 193  * @par Description: This API is event callback function for getting profile sync category
 194  *
 195  *
 196  * @par Purpose:
 197  * @par Typical use case:
 198  * @par Method of function operation:
 199  * @par Important notes:
 200  * @param[in]           buffer for incomming parameter
 201  * @param[in]           buffer for outgoing parameter
 202  * @param[out]
 203  *
 204  * @return                              0 on success
 205  *
 206  * @par Errors:
 207  *
 208  * @pre None.
 209  * @post
 210  * @see
 211  * @remarks None.
 212  *
 213  * @par Sample Code:
 214  * @code
 215  * @endcode
 216  */
 217 int event_callback_get_profile_sync_category_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 218
 219 /**
 220  * @par Description: This API is event callback function for last statistics
 221  *
 222  *
 223  * @par Purpose:
 224  * @par Typical use case:
 225  * @par Method of function operation:
 226  * @par Important notes:
 227  * @param[in]           buffer for incomming parameter
 228  * @param[in]           buffer for outgoing parameter
 229  * @param[out]
 230  *
 231  * @return                              0 on success
 232  *
 233  * @par Errors:
 234  *
 235  * @pre None.
 236  * @post
 237  * @see
 238  * @remarks None.
 239  *
 240  * @par Sample Code:
 241  * @code
 242  * @endcode
 243  */
 244 int event_callback_get_profile_last_statistics_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 245
 246 /**
 247  * @par Description: This API is event callback function for add profile for CP
 248  *
 249  *
 250  * @par Purpose:
 251  * @par Typical use case:
 252  * @par Method of function operation:
 253  * @par Important notes:
 254  * @param[in]           buffer for incomming parameter
 255  * @param[in]           buffer for outgoing parameter
 256  * @param[out]
 257  *
 258  * @return                              0 on success
 259  *
 260  * @par Errors:
 261  *
 262  * @pre None.
 263  * @post
 264  * @see
 265  * @remarks None.
 266  *
 267  * @par Sample Code:
 268  * @code
 269  * @endcode
 270  */
 271 int event_callback_add_profile_cp_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 272
 273 /**
 274  * @par Description: This API is event callback function for request callog sync
 275  *
 276  *
 277  * @par Purpose:
 278  * @par Typical use case:
 279  * @par Method of function operation:
 280  * @par Important notes:
 281  * @param[in]           buffer for incomming parameter
 282  * @param[in]           buffer for outgoing parameter
 283  * @param[out]
 284  *
 285  * @return                              0 on success
 286  *
 287  * @par Errors:
 288  *
 289  * @pre None.
 290  * @post
 291  * @see
 292  * @remarks None.
 293  *
 294  * @par Sample Code:
 295  * @code
 296  * @endcode
 297  */
 298 int event_callback_request_calllog_sync_async(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 299
 300 /**
 301  * @par Description: This API is event callback function for request reset all data
 302  *
 303  *
 304  * @par Purpose:
 305  * @par Typical use case:
 306  * @par Method of function operation:
 307  * @par Important notes:
 308  * @param[in]           buffer for incomming parameter
 309  * @param[in]           buffer for outgoing parameter
 310  * @param[out]
 311  *
 312  * @return                              0 on success
 313  *
 314  * @par Errors:
 315  *
 316  * @pre None.
 317  * @post
 318  * @see
 319  * @remarks None.
 320  *
 321  * @par Sample Code:
 322  * @code
 323  * @endcode
 324  */
 325 int event_callback_request_reset_all_data_sync(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 326
 327 /**
 328  * @par Description: This API is event callback function for request reset all data
 329  *
 330  *
 331  * @par Purpose:
 332  * @par Typical use case:
 333  * @par Method of function operation:
 334  * @par Important notes:
 335  * @param[in]           buffer for incomming parameter
 336  * @param[in]           buffer for outgoing parameter
 337  * @param[out]
 338  *
 339  * @return                              0 on success
 340  *
 341  * @par Errors:
 342  *
 343  * @pre None.
 344  * @post
 345  * @see
 346  * @remarks None.
 347  *
 348  * @par Sample Code:
 349  * @code
 350  * @endcode
 351  */
 352 int event_callback_request_get_all_profiles_data(sync_agent_event_data_s * request, sync_agent_event_data_s * response);
 353
 354 #endif                          /* OMA_DS_EVENT_HANDLER_H_ */