include/tapi/ITapiMisc.h

   1 /*
   2  * libslp-tapi
   3  *
   4  * Copyright (c) 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Ja-young Gu <jygu@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20
  21 /**
  22  * @internal
  23  * @ingroup              TelephonyAPI
  24  * @addtogroup    MISC_TAPI       MISC
  25  * @{
  26  *
  27  * @file ITapiMisc.h
  28
  29  @brief This file serves as a "C" header file defines functions for Tapi Misc Services.\n
  30  It contains a sample set of function prototypes that would be required by applications.
  31  This header file defines the Telephony - MISC - API's.  These API's will be used by the
  32  processing Nitz and RTC time and some MISC functions.
  33  */
  34 #ifndef _ITAPI_MISC_H_
  35 #define _ITAPI_MISC_H_
  36
  37 #include <TelDefines.h>
  38 #include <TelUtility.h>
  39 #include <TelMisc.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  *
  47  * @brief  This function is invoked to Confirm Time zone Info.
  48  *
  49  * @par Sync (or) Async:
  50  *  This is a Asynchronous API.
  51  *
  52  * @par Important Notes:
  53  * - None.
  54  *
  55  * @warning
  56  * - None.
  57  *
  58  *
  59  * @param  [in]  timezone_info
  60  * -  timezone_info.
  61  *
  62  * @par Async Response Message:
  63  * - NA
  64  *
  65  * @pre
  66  * - None.
  67  *
  68  * @post
  69  * - None.
  70  *
  71  * @return Return Type (int) \n
  72  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
  73  * - Negative integer : it provides an error code (Refer #TapiResult_t)
  74  *
  75  * @par Prospective Clients:
  76  *  External Apps.
  77  *
  78  */
  79 int tel_confirm_misc_timezone_Info(tapi_misc_time_zone_info_type *timezone_info);
  80
  81 /**
  82  *
  83  * @brief  This function is invoked to Get Time zone Mode.
  84  *
  85  * @par Sync (or) Async:
  86  *  This is a Synchronous API.
  87  *
  88  * @par Important Notes:
  89  * - None.
  90  *
  91  * @warning
  92  * - None.
  93  *
  94  *
  95  * @param  [out]  bTimezone_valid
  96  * -  specifies whether true or false.
  97  *
  98  * @par Async Response Message:
  99  * - NA
 100  *
 101  * @pre
 102  * - None.
 103  *
 104  * @post
 105  * - None.
 106  *
 107  * @return Return Type (int) \n
 108  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
 109  * - Negative integer : it provides an error code (Refer #TapiResult_t)
 110  *
 111  * @par Prospective Clients:
 112  *  External Apps.
 113  *
 114  */
 115 int tel_get_misc_timezone_mode(int *bTimezone_valid);
 116
 117 /**
 118  *
 119  * @brief  This function is invoked to Set Time zone Information
 120  *
 121  * @par Sync (or) Async:
 122  * This is a Asynchronous API.
 123  *
 124  * @par Important Notes:
 125  * - None.
 126  *
 127  * @warning
 128  * - None.
 129  *
 130  *
 131  * @param  [in]  timezone_info
 132  *    -  specifies the time zone information
 133  *
 134  * @par Async Response Message:
 135  * - NA
 136  *
 137  * @pre
 138  *  - None.
 139  *
 140  * @post
 141  *  - None.
 142  *
 143  * @return Return Type (int) \n
 144  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
 145  * - Negative integer : it provides an error code (Refer #TapiResult_t)
 146  *
 147  * @par Prospective Clients:
 148  * External Apps.
 149  *
 150  */
 151 int tel_set_misc_timezone_info(tapi_misc_time_zone_info_type *timezone_info);
 152
 153 /**
 154  *
 155  * @brief  This function is invoked to  Get Time zone Information
 156  *
 157  * @par Sync (or) Async:
 158  * This is a Asynchronous API.
 159  *
 160  * @par Important Notes:
 161  * - None.
 162  *
 163  * @warning
 164  * - None.
 165  *
 166  *
 167  * @param  [in]
 168  * - None.
 169  *
 170  * @par Async Response Message:
 171  * - NA
 172  *
 173  * @pre
 174  *  - None.
 175  *
 176  * @post
 177  *  - None.
 178  *
 179  * @return Return Type (int) \n
 180  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
 181  * - Negative integer : it provides an error code (Refer #TapiResult_t)
 182  *
 183  * @par Prospective Clients:
 184  * External Apps.
 185  *
 186  */
 187 int tel_get_misc_timezone_info(void);
 188
 189 /**
 190  *
 191  * @brief  This function is invoked to Get ME version information.
 192  *
 193  * @par Sync (or) Async:
 194  * This is a synchronous API.
 195  *
 196  * @par Important Notes:
 197  * - None.
 198  *
 199  * @warning
 200  * - None.
 201  *
 202  * @param  [out]  ver_info
 203  *    - SW,HW version, RF calibration date, product code, model id(CDMA only), PRL/ERI information(CDMA only)
 204  *      refer #TelMiscVersionInformation
 205  *
 206  * @par Async Response Message:
 207  * - NA
 208  *
 209  * @pre
 210  *  - None.
 211  *
 212  * @post
 213  *  - None.
 214  *
 215  * @return Return Type (int) \n
 216  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
 217  * - Negative integer : it provides an error code (Refer #TapiResult_t)
 218  *
 219  * @par Prospective Clients:
 220  * External Apps.
 221  *
 222  */
 223 int tel_get_misc_me_version(TelMiscVersionInformation *ver_info);
 224
 225 /**
 226  *
 227  * @brief  This function is invoked to Get ME IMEI/ESN/MEID for each phone type.
 228  *
 229  * @par Sync (or) Async:
 230  * This is a synchronous API.
 231  *
 232  * @par Important Notes:
 233  * - None.
 234  *
 235  * @warning
 236  * - None.
 237  *
 238  * @param  [in]  sn_index
 239  *    - serial type which user wants to get from current device. Refer #TelMiscSNIndexType_t
 240  *
 241  * @param  [out]  sn_info
 242  *    - Device Serial number information. IMEI for GSM/UMTS device, ESN or MEID for CDMA device. Refer #TelMiscSNInformation
 243  *
 244  * @par Async Response Message:
 245  * - NA
 246  *
 247  * @pre
 248  *  - None.
 249  *
 250  * @post
 251  *  - None.
 252  *
 253  * @return Return Type (int) \n
 254  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
 255  * - Negative integer : it provides an error code (Refer #TapiResult_t)
 256  *
 257  * @par Prospective Clients:
 258  * External Apps.
 259  *
 260  */
 261 int tel_get_misc_me_sn(TelMiscSNIndexType_t sn_index, TelMiscSNInformation *sn_info);
 262
 263 /**
 264  *
 265  * @brief  This function is invoked to Get NAM info.
 266  *
 267  * @par Sync (or) Async:
 268  * This is a Asynchronous API.
 269  *
 270  * @par Important Notes:
 271  * - None.
 272  *
 273  * @warning
 274  * - None.
 275  *
 276  * @param  [in]  nam_info_mask, nam_index
 277  *    - nam info mask & index
 278  *
 279  * @par Async Response Message:
 280  * - NA
 281  *
 282  * @pre
 283  *  - None.
 284  *
 285  * @post
 286  *  - None.
 287  *
 288  * @return Return Type (int) \n
 289  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
 290  * - Negative integer : it provides an error code (Refer #TapiResult_t)
 291  *
 292  * @par Prospective Clients:
 293  * External Apps.
 294  *
 295  */
 296 int tel_get_misc_nam_info(unsigned short nam_info_mask, TelMiscNamIndex_t nam_index);
 297
 298 /**
 299  *
 300  * @brief  This function is invoked to Set NAM info.
 301  *
 302  * @par Sync (or) Async:
 303  * This is a Asynchronous API.
 304  *
 305  * @par Important Notes:
 306  * - None.
 307  *
 308  * @warning
 309  * - None.
 310  *
 311  * @param  [in]  nam_info
 312  *    - nam info
 313  *
 314  * @par Async Response Message:
 315  * - NA
 316  *
 317  * @pre
 318  *  - None.
 319  *
 320  * @post
 321  *  - None.
 322  *
 323  * @return Return Type (int) \n
 324  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
 325  * - Negative integer : it provides an error code (Refer #TapiResult_t)
 326  *
 327  * @par Prospective Clients:
 328  * External Apps.
 329  *
 330  */
 331 int tel_set_misc_nam_info(TelMiscNamInfo_t *nam_info);
 332
 333 /**
 334  *
 335  * @brief  This function is used to enable emergency mode
 336  * when device goes into emergency mode, user can not use normal call, SMS, and MMS service excepting emergency call.
 337  *
 338  * @par Sync (or) Async:
 339  * This is a synchronous API.
 340  *
 341  * @par Important Notes:
 342  * - None.
 343  *
 344  * @warning
 345  * - None.
 346  *
 347  * @param  [in]  mode
 348  *    - emergency mode value to request. 0:disable, 1:enable
 349  *
 350  * @par Async Response Message:
 351  * - NA
 352  *
 353  * @pre
 354  *  - None.
 355  *
 356  * @post
 357  *  - None.
 358  *
 359  * @return Return Type (int) \n
 360  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
 361  * - Negative integer : it provides an error code (Refer #TapiResult_t)
 362  *
 363  * @par Prospective Clients:
 364  * External Apps.
 365  *
 366  */
 367 int tel_set_misc_emergency_mode(int mode);
 368
 369 /**
 370  *
 371  * @brief  This function is used to get current device emergency mode status.
 372  *
 373  * @par Sync (or) Async:
 374  * This is a synchronous API.
 375  *
 376  * @par Important Notes:
 377  * - None.
 378  *
 379  * @warning
 380  * - None.
 381  *
 382  * @param  [out] mode
 383  *    - current emergency mode
 384  *
 385  * @par Async Response Message:
 386  * - NA
 387  *
 388  * @pre
 389  *  - None.
 390  *
 391  * @post
 392  *  - None.
 393  *
 394  * @return Return Type (int) \n
 395  * - Integer '0' ( same with TAPI_API_SUCCESS )  - indicating that the operation has completed successfully. \n
 396  * - Negative integer : it provides an error code (Refer #TapiResult_t)
 397  *
 398  * @par Prospective Clients:
 399  * External Apps.
 400  *
 401  */
 402 int tel_get_misc_emergency_mode(int *mode);
 403
 404 #ifdef __cplusplus
 405 }
 406 #endif
 407
 408 #endif // _ITAPI_MISC_H_
 409 /**
 410  * @}
 411  */