include/framework/ui-event-handler/ipc_agent.h

   1 /*
   2  * oma-dm-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 #ifndef IPC_AGENT_H_
  19 #define IPC_AGENT_H_
  20
  21 /*dm-agent*/
  22 #include "user-interaction/user_interaction.h"
  23
  24 /**
  25  * @par Description: API to set ipc
  26  *
  27  *
  28  * @par Purpose:
  29  * @par Typical use case:
  30  * @par Method of function operation:
  31  * @par Important notes:
  32  *
  33  * @return                      SYNC_AGENT_EVENT_SUCCESS                success
  34                                                 SYNC_AGENT_EVENT_FAIL                           fail
  35  *
  36  *
  37  * @par Errors:
  38  *
  39  * @pre None.
  40  * @post
  41  * @see
  42  * @remarks None.
  43  *
  44  * @par Sample Code:
  45  * @code
  46  * @endcode
  47  */
  48 int set_IPC();
  49
  50 /**
  51  * @par Description: API to noti start
  52  *
  53  *
  54  * @par Purpose:
  55  * @par Typical use case:
  56  * @par Method of function operation:
  57  * @par Important notes:
  58  * @param[in]   ui mode
  59  *
  60  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
  61                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
  62  *
  63  *
  64  * @par Errors:
  65  *
  66  * @pre None.
  67  * @post
  68  * @see
  69  * @remarks None.
  70  *
  71  * @par Sample Code:
  72  * @code
  73  * @endcode
  74  */
  75 int noti_start(char *ui_mode);
  76
  77 /**
  78  * @par Description: API to noti connect to server
  79  *
  80  *
  81  * @par Purpose:
  82  * @par Typical use case:
  83  * @par Method of function operation:
  84  * @par Important notes:
  85  *
  86  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
  87                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
  88  *
  89  *
  90  * @par Errors:
  91  *
  92  * @pre None.
  93  * @post
  94  * @see
  95  * @remarks None.
  96  *
  97  * @par Sample Code:
  98  * @code
  99  * @endcode
 100  */
 101 int noti_download();
 102
 103 /**
 104  * @par Description: API to noti install
 105  *
 106  *
 107  * @par Purpose:
 108  * @par Typical use case:
 109  * @par Method of function operation:
 110  * @par Important notes:
 111  *
 112  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 113                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 114  *
 115  *
 116  * @par Errors:
 117  *
 118  * @pre None.
 119  * @post
 120  * @see
 121  * @remarks None.
 122  *
 123  * @par Sample Code:
 124  * @code
 125  * @endcode
 126  */
 127 int noti_install();
 128
 129 /**
 130  * @par Description: API to noti send download info
 131  *
 132  *
 133  * @par Purpose:
 134  * @par Typical use case:
 135  * @par Method of function operation:
 136  * @par Important notes:
 137  * @param[in]   filesize
 138  * @param[in]   file path
 139  *
 140  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 141                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 142  *
 143  *
 144  * @par Errors:
 145  *
 146  * @pre None.
 147  * @post
 148  * @see
 149  * @remarks None.
 150  *
 151  * @par Sample Code:
 152  * @code
 153  * @endcode
 154  */
 155 int noti_send_download_info(int filesize, char *path);
 156
 157 /**
 158  * @par Description: API to noti low batter
 159  *
 160  *
 161  * @par Purpose:
 162  * @par Typical use case:
 163  * @par Method of function operation:
 164  * @par Important notes:
 165  * @param[in]   battery level
 166  *
 167  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 168                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 169  *
 170  *
 171  * @par Errors:
 172  *
 173  * @pre None.
 174  * @post
 175  * @see
 176  * @remarks None.
 177  *
 178  * @par Sample Code:
 179  * @code
 180  * @endcode
 181  */
 182 int noti_low_battery(char *battery_level);
 183
 184 /**
 185  * @par Description: API to alert uic display
 186  *
 187  *
 188  * @par Purpose:
 189  * @par Typical use case:
 190  * @par Method of function operation:
 191  * @par Important notes:
 192  * @param[in]   uic_data
 193  *
 194  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 195                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 196  *
 197  *
 198  * @par Errors:
 199  *
 200  * @pre None.
 201  * @post
 202  * @see
 203  * @remarks None.
 204  *
 205  * @par Sample Code:
 206  * @code
 207  * @endcode
 208  */
 209 int alert_uic_display(uic_data * uic_value);
 210
 211 /**
 212  * @par Description: API to alert uic confirm
 213  *
 214  *
 215  * @par Purpose:
 216  * @par Typical use case:
 217  * @par Method of function operation:
 218  * @par Important notes:
 219  * @param[in]   uic_data
 220  *
 221  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 222                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 223  *
 224  *
 225  * @par Errors:
 226  *
 227  * @pre None.
 228  * @post
 229  * @see
 230  * @remarks None.
 231  *
 232  * @par Sample Code:
 233  * @code
 234  * @endcode
 235  */
 236 int alert_uic_confirmation(uic_data * uic_value);
 237
 238 /**
 239  * @par Description: API to alert uic input
 240  *
 241  *
 242  * @par Purpose:
 243  * @par Typical use case:
 244  * @par Method of function operation:
 245  * @par Important notes:
 246  * @param[in]   uic_data
 247  *
 248  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 249                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 250  *
 251  *
 252  * @par Errors:
 253  *
 254  * @pre None.
 255  * @post
 256  * @see
 257  * @remarks None.
 258  *
 259  * @par Sample Code:
 260  * @code
 261  * @endcode
 262  */
 263 int alert_uic_inputText(uic_data * uic_value);
 264
 265 /**
 266  * @par Description: API to alert single choice
 267  *
 268  *
 269  * @par Purpose:
 270  * @par Typical use case:
 271  * @par Method of function operation:
 272  * @par Important notes:
 273  * @param[in]   uic_data
 274  *
 275  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 276                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 277  *
 278  *
 279  * @par Errors:
 280  *
 281  * @pre None.
 282  * @post
 283  * @see
 284  * @remarks None.
 285  *
 286  * @par Sample Code:
 287  * @code
 288  * @endcode
 289  */
 290 int alert_uic_single_choice(uic_data * uic_value);
 291
 292 /**
 293  * @par Description: API to alert multiple choice
 294  *
 295  *
 296  * @par Purpose:
 297  * @par Typical use case:
 298  * @par Method of function operation:
 299  * @par Important notes:
 300  * @param[in]   uic_data
 301  *
 302  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 303                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 304  *
 305  *
 306  * @par Errors:
 307  *
 308  * @pre None.
 309  * @post
 310  * @see
 311  * @remarks None.
 312  *
 313  * @par Sample Code:
 314  * @code
 315  * @endcode
 316  */
 317 int alert_uic_multiple_choice(uic_data * uic_value);
 318
 319 /**
 320  * @par Description: API to noti engine fail
 321  *
 322  *
 323  * @par Purpose:
 324  * @par Typical use case:
 325  * @par Method of function operation:
 326  * @par Important notes:
 327  * @param[in]   previous noti id
 328  * @param[in]   fail type
 329  *
 330  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 331                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 332  *
 333  *
 334  * @par Errors:
 335  *
 336  * @pre None.
 337  * @post
 338  * @see
 339  * @remarks None.
 340  *
 341  * @par Sample Code:
 342  * @code
 343  * @endcode
 344  */
 345 int noti_engine_fail(int prev_noti_id, int fail_type);
 346
 347 /**
 348  * @par Description: API to noti wifi only download fail
 349  *
 350  *
 351  * @par Purpose:
 352  * @par Typical use case:
 353  * @par Method of function operation:
 354  * @par Important notes:
 355  *
 356  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 357                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 358  *
 359  *
 360  * @par Errors:
 361  *
 362  * @pre None.
 363  * @post
 364  * @see
 365  * @remarks None.
 366  *
 367  * @par Sample Code:
 368  * @code
 369  * @endcode
 370  */
 371 int noti_wifi_only_download_fail();
 372
 373 /**
 374  * @par Description: API to noti memory full
 375  *
 376  *
 377  * @par Purpose:
 378  * @par Typical use case:
 379  * @par Method of function operation:
 380  * @par Important notes:
 381  * @param[in]   int type, file size
 382  *
 383  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 384                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 385  *
 386  *
 387  * @par Errors:
 388  *
 389  * @pre None.
 390  * @post
 391  * @see
 392  * @remarks None.
 393  *
 394  * @par Sample Code:
 395  * @code
 396  * @endcode
 397  */
 398 int noti_memory_full(int file_size);
 399
 400 /**
 401  * @par Description: API to noti over max file size
 402  *
 403  *
 404  * @par Purpose:
 405  * @par Typical use case:
 406  * @par Method of function operation:
 407  * @par Important notes:
 408  *
 409  * @return                      RESPONSE_TYPE_OK                                                                                                                                                                                                success
 410                                                 RESPONSE_TYPE_NONE , RESPONSE_TYPE_CANCEL, RESPONSE_TYPE_TIMEOVER               fail
 411  *
 412  *
 413  * @par Errors:
 414  *
 415  * @pre None.
 416  * @post
 417  * @see
 418  * @remarks None.
 419  *
 420  * @par Sample Code:
 421  * @code
 422  * @endcode
 423  */
 424 int noti_over_max_file_size();
 425
 426 #endif                          /* IPC_AGENT_H_ */