doc/libtapi_doc.h

   1 /*
   2  * libslp-tapi
   3  *
   4  * Copyright (c) 2014 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 #ifndef __TIZEN_TELEPHONY_SERVICE_DOC_H__
  22 #define __TIZEN_TELEPHONY_SERVICE_DOC_H__
  23
  24 /**
  25  * @ingroup CAPI_TELEPHONY_FRAMEWORK
  26  * @defgroup CAPI_TELEPHONY_SERVICE Telephony Service
  27  * @brief The Telephony Service module provides call, modem, network, phonebook, SAT, SIM, SMS, and SS services.
  28  *
  29  * @section CAPI_TELEPHONY_SERVICE_HEADER Required Header
  30  *   \#include <tapi_common.h>
  31  *
  32  * @section CAPI_TELEPHONY_SERVICE_OVERVIEW Overview
  33  * The Telephony Service module provides call, modem, network, phonebook, SAT, SIM, SMS, and SS services.
  34  * @section CAPI_TELEPHONY_SERVICE_FEATURE Related Features
  35  * This API is related with the following feature:\n
  36  * - http://tizen.org/feature/network.telephony
  37  *
  38  * It is recommended to design feature related codes in your application for reliability.\n
  39  *
  40  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  41  *
  42  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  43  *
  44  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
  45  */
  46
  47 /**
  48  * @ingroup CAPI_TELEPHONY_SERVICE
  49  * @defgroup CAPI_TELEPHONY_SERVICE_CALL Call
  50  * @brief The Call API provides functions related call services.
  51  * @section CAPI_TELEPHONY_SERVICE_CALL_HEADER Required Header
  52  *   \#include <ITapiCall.h>
  53  *
  54  * @section CAPI_TELEPHONY_SERVICE_CALL_OVERVIEW Overview
  55  * Call APIs allow an application to accomplish the following services:
  56  * - Make a mobile originated Emergency call, Voice call, or Video call.
  57  * - Accept or Reject incoming calls.
  58  * - Release Calls.
  59  * - Call dependent supplementary services such as call hold, retrieve, DTMF.
  60  * - Multi-party call management, setup conference call, split conference call.
  61  * - Call information such as get call information, get line identification number.
  62  * - To verify whether a call (voice / video) is possible at any given time.
  63  *
  64  * @section CAPI_TELEPHONY_SERVICE_CALL_FEATURE Related Features
  65  * This API is related with the following feature:\n
  66  * - http://tizen.org/feature/network.telephony
  67  *
  68  * It is recommended to design feature related codes in your application for reliability.\n
  69  *
  70  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  71  *
  72  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  73  *
  74  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
  75  */
  76
  77 /**
  78  * @ingroup CAPI_TELEPHONY_SERVICE
  79  * @defgroup CAPI_TELEPHONY_SERVICE_MODEM Modem
  80  * @brief The Modem API provides functions related modem services.
  81  *
  82  * @section CAPI_TELEPHONY_SERVICE_MODEM_HEADER Required Header
  83  *   \#include <ITapiModem.h>
  84  *
  85  * @section CAPI_TELEPHONY_SERVICE_MODEM_OVERVIEW Overview
  86  * Modem APIs allow an application to accomplish the following services:
  87  * - Process power command
  88  * - Reset the phone power (on / off)
  89  * - Process airplane mode
  90  *
  91  * @section CAPI_TELEPHONY_SERVICE_MODEM_FEATURE Related Features
  92  * This API is related with the following feature:\n
  93  * - http://tizen.org/feature/network.telephony
  94  *
  95  * It is recommended to design feature related codes in your application for reliability.\n
  96  *
  97  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  98  *
  99  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 100  *
 101  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
 102  */
 103
 104 /**
 105  * @ingroup CAPI_TELEPHONY_SERVICE
 106  * @defgroup CAPI_TELEPHONY_SERVICE_NETWORK Network
 107  * @brief The Network API provides functions related network services.
 108  * @section CAPI_TELEPHONY_SERVICE_NETWORK_HEADER Required Header
 109  *   \#include <ITapiNetwork.h>
 110  *
 111  * @section CAPI_TELEPHONY_SERVICE_NETWORK_OVERVIEW Overview
 112  * Network APIs allow an application to accomplish the following services:
 113  * - Search and Select Network
 114  * - Get Network information
 115  * - Get and Set Preferred PLMN
 116  *
 117  * @section CAPI_TELEPHONY_SERVICE_NETWORK_FEATURE Related Features
 118  * This API is related with the following feature:\n
 119  * - http://tizen.org/feature/network.telephony
 120  *
 121  * It is recommended to design feature related codes in your application for reliability.\n
 122  *
 123  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 124  *
 125  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 126  *
 127  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
 128  */
 129
 130 /**
 131  * @ingroup CAPI_TELEPHONY_SERVICE
 132  * @defgroup CAPI_TELEPHONY_SERVICE_PHONEBOOK Phonebook
 133  * @brief The Phonebook API provides functions related phonebook services.
 134  *
 135  * @section CAPI_TELEPHONY_SERVICE_PHONEBOOK_HEADER Required Header
 136  *   \#include <ITapiPhonebook.h>
 137  *
 138  * @section CAPI_TELEPHONY_SERVICE_PHONEBOOK Overview
 139  * Telephony provides APIs for various phonebook related features such as getting SIM initialization status,
 140  * supported phonebook types, total records and used records in phonebook, phonebook entry information,
 141  * and reading, updating, deleting of SIM phonebook records.
 142  *
 143  * @section CAPI_TELEPHONY_SERVICE_PHONEBOOK_FEATURE Related Features
 144  * This API is related with the following feature:\n
 145  * - http://tizen.org/feature/network.telephony
 146  *
 147  * It is recommended to design feature related codes in your application for reliability.\n
 148  *
 149  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 150  *
 151  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 152  *
 153  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
 154  */
 155
 156 /**
 157  * @ingroup CAPI_TELEPHONY_SERVICE
 158  * @defgroup CAPI_TELEPHONY_SERVICE_SAT SAT
 159  * @brief The SAT API provides functions related SAT services.
 160  *
 161  * @section CAPI_TELEPHONY_SERVICE_SAT_HEADER Required Header
 162  *   \#include <ITapiSat.h>
 163  *
 164  * @section CAPI_TELEPHONY_SERVICE_SAT_OVERVIEW Overview
 165  * SAT APIs allow an application to accomplish the following services:
 166  * - Get main menu information from the SIM application
 167  * - Send envelope commands to the SIM application
 168  * - Send the execution results of which the SIM application requests from other applications
 169  * - Send UI / User confirmation to the SIM application
 170  * Note: Telephony SAT functionality allows message relaying from a USIM application to SAT related applications.
 171  *
 172  * @section CAPI_TELEPHONY_SERVICE_SAT_FEATURE Related Features
 173  * This API is related with the following feature:\n
 174  * - http://tizen.org/feature/network.telephony
 175  *
 176  * It is recommended to design feature related codes in your application for reliability.\n
 177  *
 178  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 179  *
 180  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 181  *
 182  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
 183  */
 184
 185 /**
 186  * @ingroup CAPI_TELEPHONY_SERVICE
 187  * @defgroup CAPI_TELEPHONY_SERVICE_SIM SIM
 188  * @brief The SIM API provides functions related SIM services.
 189  *
 190  * @section CAPI_TELEPHONY_SERVICE_SIM_HEADER Required Header
 191  *   \#include <ITapiSim.h>
 192  *
 193  * @section CAPI_TELEPHONY_SERVICE_SIM_OVERVIEW Overview
 194  * SIM APIs allow an application to accomplish the following services:
 195  * - Get Card Init status and Identification
 196  * - Get the Card Type i.e. whether the SIM Card is a GSM SIM or a 3G SIM
 197  * - Set and Get the language preference information stored in the SIM
 198  * - Get the ECC (Emergency Call Codes) data
 199  * - Get the IMSI (International Mobile Subscriber Identity) information
 200  * - Set and Get the mailbox information stored in the SIM
 201  * - Set and Get the message indication status stored in the SIM
 202  * - Enable, Disable, Change, and Verify the SIM Lock status
 203  *
 204  * @section CAPI_TELEPHONY_SERVICE_SIM_FEATURE Related Features
 205  * This API is related with the following feature:\n
 206  * - http://tizen.org/feature/network.telephony
 207  *
 208  * It is recommended to design feature related codes in your application for reliability.\n
 209  *
 210  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 211  *
 212  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 213  *
 214  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
 215  */
 216
 217 /**
 218  * @ingroup CAPI_TELEPHONY_SERVICE
 219  * @defgroup CAPI_TELEPHONY_SERVICE_SMS SMS
 220  * @brief The SMS API provides functions related SMS services.
 221  * @section CAPI_TELEPHONY_SERVICE_SMS_HEADER Required Header
 222  *   \#include <ITapiNetText.h>
 223  *
 224  * @section CAPI_TELEPHONY_SERVICE_SMS_OVERVIEW Overview
 225  * SMS APIs allow an application to accomplish the following services:
 226  * - Send, save, receive, read, and delete network texts
 227  * - Receive Cell-Broadcast Message
 228  * - Set and Get Cell broadcast configuration
 229  * - Set message status, memory status
 230  * - Set and Get SMS parameters
 231  *
 232  * @section CAPI_TELEPHONY_SERVICE_SMS_FEATURE Related Features
 233  * This API is related with the following feature:\n
 234  * - http://tizen.org/feature/network.telephony
 235  *
 236  * It is recommended to design feature related codes in your application for reliability.\n
 237  *
 238  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 239  *
 240  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 241  *
 242  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
 243  */
 244
 245 /**
 246  * @ingroup CAPI_TELEPHONY_SERVICE
 247  * @defgroup CAPI_TELEPHONY_SERVICE_SS Supplementary Service
 248  * @brief The Supplementary Service API provides functions related SS services.
 249  *
 250  * @section CAPI_TELEPHONY_SERVICE_SS_HEADER Required Header
 251  *   \#include <ITapiSs.h>
 252  *
 253  * @section CAPI_TELEPHONY_SERVICE_SS_OVERVIEW Overview
 254  * Supplementary Service APIs allow an application to accomplish the following services:
 255  * - Activate, Deactivate, and Change the password for call barring
 256  * - Register, Deregister, Activate, and Deactivate call forwarding and call waiting
 257  * - Set and Get the CLI(Calling Line Identification) status
 258  * - Send USSD request
 259  *
 260  * Telephony provides APIs to activate/deactivate call barring, get the barring status, and change the barring password.\n
 261  * This service makes it possible for a mobile subscriber to activate barring for certain categories of outgoing or incoming calls.
 262  * It also allows the deactivation of call barring based on categories that are set.\n
 263  * The mobile subscriber may also determine the type of barring preferred for incoming/outgoing calls, by subscribing to a set of one or more unique barring programs.\n
 264  * Telephony provides APIs to activate/deactivate the call forwarding option at the Network and to get the call forward status.\n
 265  * Call forwarding allows a user to forward incoming calls to another party.
 266  * This service permits a called mobile subscriber to have the network send all incoming calls, or just those associated with a specific Basic service group meeting various call FORWARD conditions, to another directory number.\n
 267  * The ability of the served mobile subscriber to originate calls is unaffected. If the service is activated, a call is forwarded only if the enabled forward condition is satisfied.\n
 268  * An application has to call this API in order to explicitly register/deregister/activate/deactivate the call forwarding option. A request will be sent irrespective of whether another SS call forward is already in progress.\n
 269  *
 270  * @section CAPI_TELEPHONY_SERVICE_SS_FEATURE Related Features
 271  * This API is related with the following feature:\n
 272  * - http://tizen.org/feature/network.telephony
 273  *
 274  * It is recommended to design feature related codes in your application for reliability.\n
 275  *
 276  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 277  *
 278  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 279  *
 280  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
 281  */
 282
 283 /**
 284  * @ingroup CAPI_TELEPHONY_SERVICE
 285  * @defgroup CAPI_TELEPHONY_SERVICE_OEM OEM Service
 286  * @brief The OEM API provides functions related OEM services.
 287  *
 288  * @section CAPI_TELEPHONY_SERVICE_OEM_HEADER Required Header
 289  *   \#include <ITapiOem.h>
 290  *
 291  * @section CAPI_TELEPHONY_SERVICE_OEM_OVERVIEW Overview
 292  * OEM Service APIs allow an application to accomplish the following services:
 293  * - Send OEM (proprietary) data to modem
 294  * - Receive OEM (proprietary) data to modem (as notification)
 295  *
 296  * Telephony provides APIs to send OEM (proprietary) data to modem.\n
 297  * This service makes it possible for a application to send properitary format of data to modem.\n
 298  * The data passed through this API would be by-passed to modem directly.\n
 299  * Application can request for either a synchrnous or asynchronous mode of operations.
 300  * Telephony provides interface to application receive prorietary data from modem directly.
 301  * The data is by-apssed through Telephony framework to applications.\n
 302  *
 303  * @section CAPI_TELEPHONY_SERVICE_OEM_FEATURE Related Features
 304  * This API is related with the following feature:\n
 305  * - http://tizen.org/feature/network.telephony
 306  *
 307  * It is recommended to design feature related codes in your application for reliability.\n
 308  *
 309  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 310  *
 311  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 312  *
 313  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
 314  */
 315
 316 #endif /* __TIZEN_TELEPHONY_SERVICE_DOC_H__ */