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  * @internal
  26  * @ingroup CAPI_TELEPHONY_FRAMEWORK
  27  * @defgroup CAPI_TELEPHONY_SERVICE Telephony Service
  28  * @brief The Telephony Service module provides call, modem, network, phonebook, SAT, SIM, SMS, and SS services.
  29  *
  30  * @section CAPI_TELEPHONY_SERVICE_HEADER Required Header
  31  *   \#include <tapi_common.h>
  32  *
  33  * @section CAPI_TELEPHONY_SERVICE_OVERVIEW Overview
  34  * The Telephony Service module provides call, modem, network, phonebook, SAT, SIM, SMS, and SS services.
  35  * @section CAPI_TELEPHONY_SERVICE_FEATURE Related Features
  36  * This API is related with the following feature:\n
  37  * - http://tizen.org/feature/network.telephony
  38  *
  39  * It is recommended to design feature related codes in your application for reliability.\n
  40  *
  41  * 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
  42  *
  43  * 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
  44  *
  45  * 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>
  46  */
  47
  48 /**
  49  * @internal
  50  * @ingroup CAPI_TELEPHONY_SERVICE
  51  * @defgroup CAPI_TELEPHONY_SERVICE_CALL Call
  52  * @brief
  53  * @section CAPI_TELEPHONY_SERVICE_CALL_HEADER Required Header
  54  *   \#include <ITapiCall.h>
  55  *
  56  * @section CAPI_TELEPHONY_SERVICE_CALL_OVERVIEW Overview
  57  * Call APIs allow an application to accomplish the following services:
  58  * - Make a mobile originated Emergency call, Voice call, or Video call.
  59  * - Accept or Reject incoming calls.
  60  * - Release Calls.
  61  * - Call dependent supplementary services such as call hold, retrieve, DTMF.
  62  * - Multi-party call management, setup conference call, split conference call.
  63  * - Call information such as get call information, get line identification number.
  64  * - To verify whether a call (voice / video) is possible at any given time.
  65  *
  66  * @section CAPI_TELEPHONY_SERVICE_CALL_FEATURE Related Features
  67  * This API is related with the following feature:\n
  68  * - http://tizen.org/feature/network.telephony
  69  *
  70  * It is recommended to design feature related codes in your application for reliability.\n
  71  *
  72  * 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
  73  *
  74  * 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
  75  *
  76  * 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>
  77  */
  78
  79 /**
  80  * @internal
  81  * @ingroup CAPI_TELEPHONY_SERVICE
  82  * @defgroup CAPI_TELEPHONY_SERVICE_MODEM Modem
  83  * @brief
  84  *
  85  * @section CAPI_TELEPHONY_SERVICE_MODEM_HEADER Required Header
  86  *   \#include <ITapiModem.h>
  87  *
  88  * @section CAPI_TELEPHONY_SERVICE_MODEM_OVERVIEW Overview
  89  * Modem APIs allow an application to accomplish the following services:
  90  * - Process power command
  91  * - Reset the phone power (on / off)
  92  * - Process airplane mode
  93  *
  94  * @section CAPI_TELEPHONY_SERVICE_MODEM_FEATURE Related Features
  95  * This API is related with the following feature:\n
  96  * - http://tizen.org/feature/network.telephony
  97  *
  98  * It is recommended to design feature related codes in your application for reliability.\n
  99  *
 100  * 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
 101  *
 102  * 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
 103  *
 104  * 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>
 105  */
 106
 107 /**
 108  * @internal
 109  * @ingroup CAPI_TELEPHONY_SERVICE
 110  * @defgroup CAPI_TELEPHONY_SERVICE_NETWORK Network
 111  * @brief
 112  * @section CAPI_TELEPHONY_SERVICE_NETWORK_HEADER Required Header
 113  *   \#include <ITapiNetwork.h>
 114  *
 115  * @section CAPI_TELEPHONY_SERVICE_NETWORK_OVERVIEW Overview
 116  * Network APIs allow an application to accomplish the following services:
 117  * - Search and Select Network
 118  * - Get Network information
 119  * - Get and Set Preferred PLMN
 120  *
 121  * @section CAPI_TELEPHONY_SERVICE_NETWORK_FEATURE Related Features
 122  * This API is related with the following feature:\n
 123  * - http://tizen.org/feature/network.telephony
 124  *
 125  * It is recommended to design feature related codes in your application for reliability.\n
 126  *
 127  * 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
 128  *
 129  * 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
 130  *
 131  * 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>
 132  */
 133
 134 /**
 135  * @internal
 136  * @ingroup CAPI_TELEPHONY_SERVICE
 137  * @defgroup CAPI_TELEPHONY_SERVICE_PHONEBOOK Phonebook
 138  * @brief
 139  *
 140  * @section CAPI_TELEPHONY_SERVICE_PHONEBOOK_HEADER Required Header
 141  *   \#include <ITapiPhonebook.h>
 142  *
 143  * @section CAPI_TELEPHONY_SERVICE_PHONEBOOK Overview
 144  * Telephony provides APIs for various phonebook related features such as getting SIM initialization status,
 145  * supported phonebook types, total records and used records in phonebook, phonebook entry information,
 146  * and reading, updating, deleting of SIM phonebook records.
 147  *
 148  * @section CAPI_TELEPHONY_SERVICE_PHONEBOOK_FEATURE Related Features
 149  * This API is related with the following feature:\n
 150  * - http://tizen.org/feature/network.telephony
 151  *
 152  * It is recommended to design feature related codes in your application for reliability.\n
 153  *
 154  * 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
 155  *
 156  * 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
 157  *
 158  * 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>
 159  */
 160
 161 /**
 162  * @internal
 163  * @ingroup CAPI_TELEPHONY_SERVICE
 164  * @defgroup CAPI_TELEPHONY_SERVICE_SAT SAT
 165  * @brief
 166  *
 167  * @section CAPI_TELEPHONY_SERVICE_SAT_HEADER Required Header
 168  *   \#include <ITapiSat.h>
 169  *
 170  * @section CAPI_TELEPHONY_SERVICE_SAT_OVERVIEW Overview
 171  * SAT APIs allow an application to accomplish the following services:
 172  * - Get main menu information from the SIM application
 173  * - Send envelope commands to the SIM application
 174  * - Send the execution results of which the SIM application requests from other applications
 175  * - Send UI / User confirmation to the SIM application
 176  * Note: Telephony SAT functionality allows message relaying from a USIM application to SAT related applications.
 177  *
 178  * @section CAPI_TELEPHONY_SERVICE_SAT_FEATURE Related Features
 179  * This API is related with the following feature:\n
 180  * - http://tizen.org/feature/network.telephony
 181  *
 182  * It is recommended to design feature related codes in your application for reliability.\n
 183  *
 184  * 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
 185  *
 186  * 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
 187  *
 188  * 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>
 189  */
 190
 191 /**
 192  * @internal
 193  * @ingroup CAPI_TELEPHONY_SERVICE
 194  * @defgroup CAPI_TELEPHONY_SERVICE_SIM SIM
 195  * @brief
 196  *
 197  * @section CAPI_TELEPHONY_SERVICE_SIM_HEADER Required Header
 198  *   \#include <ITapiSim.h>
 199  *
 200  * @section CAPI_TELEPHONY_SERVICE_SIM_OVERVIEW Overview
 201  * SIM APIs allow an application to accomplish the following services:
 202  * - Get Card Init status and Identification
 203  * - Get the Card Type i.e. whether the SIM Card is a GSM SIM or a 3G SIM
 204  * - Set and Get the language preference information stored in the SIM
 205  * - Get the ECC (Emergency Call Codes) data
 206  * - Get the IMSI (International Mobile Subscriber Identity) information
 207  * - Set and Get the mailbox information stored in the SIM
 208  * - Set and Get the message indication status stored in the SIM
 209  * - Enable, Disable, Change, and Verify the SIM Lock status
 210  *
 211  * @section CAPI_TELEPHONY_SERVICE_SIM_FEATURE Related Features
 212  * This API is related with the following feature:\n
 213  * - http://tizen.org/feature/network.telephony
 214  *
 215  * It is recommended to design feature related codes in your application for reliability.\n
 216  *
 217  * 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
 218  *
 219  * 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
 220  *
 221  * 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>
 222  */
 223
 224 /**
 225  * @internal
 226  * @ingroup CAPI_TELEPHONY_SERVICE
 227  * @defgroup CAPI_TELEPHONY_SERVICE_SMS SMS
 228  * @brief
 229  * @section CAPI_TELEPHONY_SERVICE_SMS_HEADER Required Header
 230  *   \#include <ITapiNetText.h>
 231  *
 232  * @section CAPI_TELEPHONY_SERVICE_SMS_OVERVIEW Overview
 233  * SMS APIs allow an application to accomplish the following services:
 234  * - Send, save, receive, read, and delete network texts
 235  * - Receive Cell-Broadcast Message
 236  * - Set and Get Cell broadcast configuration
 237  * - Set message status, memory status
 238  * - Set and Get SMS parameters
 239  *
 240  * @section CAPI_TELEPHONY_SERVICE_SMS_FEATURE Related Features
 241  * This API is related with the following feature:\n
 242  * - http://tizen.org/feature/network.telephony
 243  *
 244  * It is recommended to design feature related codes in your application for reliability.\n
 245  *
 246  * 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
 247  *
 248  * 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
 249  *
 250  * 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>
 251  */
 252
 253 /**
 254  * @internal
 255  * @ingroup CAPI_TELEPHONY_SERVICE
 256  * @defgroup CAPI_TELEPHONY_SERVICE_SS Supplementary Service
 257  * @brief
 258  *
 259  * @section CAPI_TELEPHONY_SERVICE_SS_HEADER Required Header
 260  *   \#include <ITapiSs.h>
 261  *
 262  * @section CAPI_TELEPHONY_SERVICE_SS_OVERVIEW Overview
 263  * Supplementary Service APIs allow an application to accomplish the following services:
 264  * - Activate, Deactivate, and Change the password for call barring
 265  * - Register, Deregister, Activate, and Deactivate call forwarding and call waiting
 266  * - Set and Get the CLI(Calling Line Identification) status
 267  * - Send USSD request
 268  *
 269  * Telephony provides APIs to activate/deactivate call barring, get the barring status, and change the barring password.\n
 270  * This service makes it possible for a mobile subscriber to activate barring for certain categories of outgoing or incoming calls.
 271  * It also allows the deactivation of call barring based on categories that are set.\n
 272  * 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
 273  * Telephony provides APIs to activate/deactivate the call forwarding option at the Network and to get the call forward status.\n
 274  * Call forwarding allows a user to forward incoming calls to another party.
 275  * 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
 276  * 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
 277  * 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
 278  *
 279  * @section CAPI_TELEPHONY_SERVICE_SS_FEATURE Related Features
 280  * This API is related with the following feature:\n
 281  * - http://tizen.org/feature/network.telephony
 282  *
 283  * It is recommended to design feature related codes in your application for reliability.\n
 284  *
 285  * 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
 286  *
 287  * 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
 288  *
 289  * 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>
 290  */
 291
 292 #endif /* __TIZEN_TELEPHONY_SERVICE_DOC_H__ */