include/Framework/Event/OMA_DS_Event_Handler.h

   1 /*
   2  * oma-ds-service
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: JuHak Park <juhaki.park@samsung.com>,
   7  *          JuneHyuk Lee <junhyuk7.lee@samsung.com>,
   8  *          SunBong Ha <sunbong.ha@samsung.com>
   9  *
  10  * Licensed under the Apache License, Version 2.0 (the "License");
  11  * you may not use this file except in compliance with the License.
  12  * You may obtain a copy of the License at
  13  *
  14  * http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  * Unless required by applicable law or agreed to in writing, software
  17  * distributed under the License is distributed on an "AS IS" BASIS,
  18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  * See the License for the specific language governing permissions and
  20  * limitations under the License.
  21  *
  22  */
  23
  24
  25
  26
  27
  28 /*
  29  * For any sort of issue you concern as to this software,
  30  * you may use following point of contact.
  31  * All resources contributed on this software
  32  * are orinigally written by S-Core Inc., a member of Samsung Group.
  33  *
  34  * SeongWon Shim <seongwon.shim@samsung.com>
  35  */
  36
  37 /**
  38  *   @OMA_DS_Event_Handler.h
  39  *   @version                                                                   0.1
  40  *   @brief                                                                             This file is the header file of interface for event callback function(from UI)
  41  */
  42
  43 #ifndef OMA_DS_EVENT_HANDLER_H_
  44 #define OMA_DS_EVENT_HANDLER_H_
  45
  46 #include <stdio.h>
  47 #include "agent-framework/Event/Event_Handler.h"
  48
  49 /**
  50  * @par Description: This API is event callback function for add account
  51  *
  52  *
  53  * @par Purpose:
  54  * @par Typical use case:
  55  * @par Method of function operation:
  56  * @par Important notes:
  57  * @param[in]           buffer for incomming parameter
  58  * @param[in]           buffer for outgoing parameter
  59  * @param[out]
  60  *
  61  * @return                              0 on success
  62  *
  63  * @par Errors:
  64  *
  65  * @pre None.
  66  * @post
  67  * @see
  68  * @remarks None.
  69  *
  70  * @par Sample Code:
  71  * @code
  72  * @endcode
  73  */
  74 /*TODO have to be removed after removing vconf*/
  75 int event_callback_add_account(Event_Data *request, Event_Data *response);
  76
  77 /**
  78  * @par Description: This API is event callback function for edit account
  79  *
  80  *
  81  * @par Purpose:
  82  * @par Typical use case:
  83  * @par Method of function operation:
  84  * @par Important notes:
  85  * @param[in]           buffer for incomming parameter
  86  * @param[in]           buffer for outgoing parameter
  87  * @param[out]
  88  *
  89  * @return                              0 on success
  90  *
  91  * @par Errors:
  92  *
  93  * @pre None.
  94  * @post
  95  * @see
  96  * @remarks None.
  97  *
  98  * @par Sample Code:
  99  * @code
 100  * @endcode
 101  */
 102 /*TODO have to be removed after removing vconf*/
 103 int event_callback_edit_account(Event_Data *request, Event_Data *response);
 104
 105 /**
 106  * @par Description: This API is event callback function for auto configure
 107  *
 108  *
 109  * @par Purpose:
 110  * @par Typical use case:
 111  * @par Method of function operation:
 112  * @par Important notes:
 113  * @param[in]           buffer for incomming parameter
 114  * @param[in]           buffer for outgoing parameter
 115  * @param[out]
 116  *
 117  * @return                              0 on success
 118  *
 119  * @par Errors:
 120  *
 121  * @pre None.
 122  * @post
 123  * @see
 124  * @remarks None.
 125  *
 126  * @par Sample Code:
 127  * @code
 128  * @endcode
 129  */
 130 /*TODO have to be removed after removing vconf*/
 131 int event_callback_auto_configure(Event_Data *request, Event_Data *response);
 132
 133 /**
 134  * @par Description: This API is event callback function for add profile
 135  *
 136  *
 137  * @par Purpose:
 138  * @par Typical use case:
 139  * @par Method of function operation:
 140  * @par Important notes:
 141  * @param[in]           buffer for incomming parameter
 142  * @param[in]           buffer for outgoing parameter
 143  * @param[out]
 144  *
 145  * @return                              0 on success
 146  *
 147  * @par Errors:
 148  *
 149  * @pre None.
 150  * @post
 151  * @see
 152  * @remarks None.
 153  *
 154  * @par Sample Code:
 155  * @code
 156  * @endcode
 157  */
 158 int event_callback_add_profile_sync(Event_Data *request, Event_Data *response);
 159
 160 /**
 161  * @par Description: This API is event callback function for edit profile
 162  *
 163  *
 164  * @par Purpose:
 165  * @par Typical use case:
 166  * @par Method of function operation:
 167  * @par Important notes:
 168  * @param[in]           buffer for incomming parameter
 169  * @param[in]           buffer for outgoing parameter
 170  * @param[out]
 171  *
 172  * @return                              0 on success
 173  *
 174  * @par Errors:
 175  *
 176  * @pre None.
 177  * @post
 178  * @see
 179  * @remarks None.
 180  *
 181  * @par Sample Code:
 182  * @code
 183  * @endcode
 184  */
 185 int event_callback_edit_profile_sync(Event_Data *request, Event_Data *response);
 186
 187 /**
 188  * @par Description: This API is event callback function for delete profile
 189  *
 190  *
 191  * @par Purpose:
 192  * @par Typical use case:
 193  * @par Method of function operation:
 194  * @par Important notes:
 195  * @param[in]           buffer for incomming parameter
 196  * @param[in]           buffer for outgoing parameter
 197  * @param[out]
 198  *
 199  * @return                              0 on success
 200  *
 201  * @par Errors:
 202  *
 203  * @pre None.
 204  * @post
 205  * @see
 206  * @remarks None.
 207  *
 208  * @par Sample Code:
 209  * @code
 210  * @endcode
 211  */
 212 int event_callback_delete_profile_sync(Event_Data *request, Event_Data *response);
 213
 214 /**
 215  * @par Description: This API is event callback function for request sync
 216  *
 217  *
 218  * @par Purpose:
 219  * @par Typical use case:
 220  * @par Method of function operation:
 221  * @par Important notes:
 222  * @param[in]           buffer for incomming parameter
 223  * @param[in]           buffer for outgoing parameter
 224  * @param[out]
 225  *
 226  * @return                              0 on success
 227  *
 228  * @par Errors:
 229  *
 230  * @pre None.
 231  * @post
 232  * @see
 233  * @remarks None.
 234  *
 235  * @par Sample Code:
 236  * @code
 237  * @endcode
 238  */
 239 int event_callback_request_sync_async(Event_Data *request, Event_Data *response);
 240
 241 /**
 242  * @par Description: This API is event callback function for auto configure
 243  *
 244  *
 245  * @par Purpose:
 246  * @par Typical use case:
 247  * @par Method of function operation:
 248  * @par Important notes:
 249  * @param[in]           buffer for incomming parameter
 250  * @param[in]           buffer for outgoing parameter
 251  * @param[out]
 252  *
 253  * @return                              0 on success
 254  *
 255  * @par Errors:
 256  *
 257  * @pre None.
 258  * @post
 259  * @see
 260  * @remarks None.
 261  *
 262  * @par Sample Code:
 263  * @code
 264  * @endcode
 265  */
 266 int event_callback_auto_configure_async(Event_Data *request, Event_Data *response);
 267
 268 /**
 269  * @par Description: This API is event callback function for cancel sync
 270  *
 271  *
 272  * @par Purpose:
 273  * @par Typical use case:
 274  * @par Method of function operation:
 275  * @par Important notes:
 276  * @param[in]           buffer for incomming parameter
 277  * @param[in]           buffer for outgoing parameter
 278  * @param[out]
 279  *
 280  * @return                              0 on success
 281  *
 282  * @par Errors:
 283  *
 284  * @pre None.
 285  * @post
 286  * @see
 287  * @remarks None.
 288  *
 289  * @par Sample Code:
 290  * @code
 291  * @endcode
 292  */
 293 int event_callback_cancel_sync_async(Event_Data *request, Event_Data *response);
 294
 295 /**
 296  * @par Description: This API is event callback function for query sync status
 297  *
 298  *
 299  * @par Purpose:
 300  * @par Typical use case:
 301  * @par Method of function operation:
 302  * @par Important notes:
 303  * @param[in]           buffer for incomming parameter
 304  * @param[in]           buffer for outgoing parameter
 305  * @param[out]
 306  *
 307  * @return                              0 on success
 308  *
 309  * @par Errors:
 310  *
 311  * @pre None.
 312  * @post
 313  * @see
 314  * @remarks None.
 315  *
 316  * @par Sample Code:
 317  * @code
 318  * @endcode
 319  */
 320 int event_callback_query_sync_status_async(Event_Data *request, Event_Data *response);
 321
 322 /**
 323  * @par Description: This API is event callback function for getting profile name
 324  *
 325  *
 326  * @par Purpose:
 327  * @par Typical use case:
 328  * @par Method of function operation:
 329  * @par Important notes:
 330  * @param[in]           buffer for incomming parameter
 331  * @param[in]           buffer for outgoing parameter
 332  * @param[out]
 333  *
 334  * @return                              0 on success
 335  *
 336  * @par Errors:
 337  *
 338  * @pre None.
 339  * @post
 340  * @see
 341  * @remarks None.
 342  *
 343  * @par Sample Code:
 344  * @code
 345  * @endcode
 346  */
 347 int event_callback_get_profile_name_sync(Event_Data *request, Event_Data *response);
 348
 349 /**
 350  * @par Description: This API is event callback function for getting profile server information
 351  *
 352  *
 353  * @par Purpose:
 354  * @par Typical use case:
 355  * @par Method of function operation:
 356  * @par Important notes:
 357  * @param[in]           buffer for incomming parameter
 358  * @param[in]           buffer for outgoing parameter
 359  * @param[out]
 360  *
 361  * @return                              0 on success
 362  *
 363  * @par Errors:
 364  *
 365  * @pre None.
 366  * @post
 367  * @see
 368  * @remarks None.
 369  *
 370  * @par Sample Code:
 371  * @code
 372  * @endcode
 373  */
 374 int event_callback_get_profile_server_info_sync(Event_Data *request, Event_Data *response);
 375
 376 /**
 377  * @par Description: This API is event callback function for getting profile sync mode
 378  *
 379  *
 380  * @par Purpose:
 381  * @par Typical use case:
 382  * @par Method of function operation:
 383  * @par Important notes:
 384  * @param[in]           buffer for incomming parameter
 385  * @param[in]           buffer for outgoing parameter
 386  * @param[out]
 387  *
 388  * @return                              0 on success
 389  *
 390  * @par Errors:
 391  *
 392  * @pre None.
 393  * @post
 394  * @see
 395  * @remarks None.
 396  *
 397  * @par Sample Code:
 398  * @code
 399  * @endcode
 400  */
 401 int event_callback_get_profile_sync_mode_sync(Event_Data *request, Event_Data *response);
 402
 403 /**
 404  * @par Description: This API is event callback function for getting profile sync category
 405  *
 406  *
 407  * @par Purpose:
 408  * @par Typical use case:
 409  * @par Method of function operation:
 410  * @par Important notes:
 411  * @param[in]           buffer for incomming parameter
 412  * @param[in]           buffer for outgoing parameter
 413  * @param[out]
 414  *
 415  * @return                              0 on success
 416  *
 417  * @par Errors:
 418  *
 419  * @pre None.
 420  * @post
 421  * @see
 422  * @remarks None.
 423  *
 424  * @par Sample Code:
 425  * @code
 426  * @endcode
 427  */
 428 int event_callback_get_profile_sync_category_sync(Event_Data *request, Event_Data *response);
 429
 430 /**
 431  * @par Description: This API is event callback function for last session information
 432  *
 433  *
 434  * @par Purpose:
 435  * @par Typical use case:
 436  * @par Method of function operation:
 437  * @par Important notes:
 438  * @param[in]           buffer for incomming parameter
 439  * @param[in]           buffer for outgoing parameter
 440  * @param[out]
 441  *
 442  * @return                              0 on success
 443  *
 444  * @par Errors:
 445  *
 446  * @pre None.
 447  * @post
 448  * @see
 449  * @remarks None.
 450  *
 451  * @par Sample Code:
 452  * @code
 453  * @endcode
 454  */
 455 int event_callback_get_profile_last_session_sync(Event_Data *request, Event_Data *response);
 456
 457 /**
 458  * @par Description: This API is event callback function for last statistics
 459  *
 460  *
 461  * @par Purpose:
 462  * @par Typical use case:
 463  * @par Method of function operation:
 464  * @par Important notes:
 465  * @param[in]           buffer for incomming parameter
 466  * @param[in]           buffer for outgoing parameter
 467  * @param[out]
 468  *
 469  * @return                              0 on success
 470  *
 471  * @par Errors:
 472  *
 473  * @pre None.
 474  * @post
 475  * @see
 476  * @remarks None.
 477  *
 478  * @par Sample Code:
 479  * @code
 480  * @endcode
 481  */
 482 int event_callback_get_profile_last_statistics_sync(Event_Data *request, Event_Data *response);
 483
 484 /**
 485  * @par Description: This API is event callback function for add profile for CP
 486  *
 487  *
 488  * @par Purpose:
 489  * @par Typical use case:
 490  * @par Method of function operation:
 491  * @par Important notes:
 492  * @param[in]           buffer for incomming parameter
 493  * @param[in]           buffer for outgoing parameter
 494  * @param[out]
 495  *
 496  * @return                              0 on success
 497  *
 498  * @par Errors:
 499  *
 500  * @pre None.
 501  * @post
 502  * @see
 503  * @remarks None.
 504  *
 505  * @par Sample Code:
 506  * @code
 507  * @endcode
 508  */
 509 int event_callback_add_profile_cp_sync(Event_Data *request, Event_Data *response);
 510
 511 #endif /* OMA_DS_EVENT_HANDLER_H_ */