doc/telephony_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __TIZEN_TELEPHONY_INFORMATION_DOC_H__
  18 #define __TIZEN_TELEPHONY_INFORMATION_DOC_H__
  19
  20 /**
  21  * @ingroup CAPI_TELEPHONY_FRAMEWORK
  22  * @defgroup CAPI_TELEPHONY_INFORMATION Telephony Information
  23  * @brief The Telephony provides call, modem, network, and SIM information.
  24  *
  25  * @section CAPI_TELEPHONY_INFORMATION_HEADER Required Header
  26  *   \#include <telephony.h>
  27  *
  28  * @section CAPI_TELEPHONY_INFORMATION_OVERVIEW Overview
  29  * The Telephony provides call, modem, network, and SIM information.
  30  * @section CAPI_TELEPHONY_INFORMATION_FEATURE Related Features
  31  * This API is related with the following feature:\n
  32  * - http://tizen.org/feature/network.telephony
  33  *
  34  * It is recommended to design feature related codes in your application for reliability.\n
  35  *
  36  * 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
  37  *
  38  * 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
  39  *
  40  * 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>
  41  */
  42
  43 /**
  44  * @ingroup CAPI_TELEPHONY_INFORMATION
  45  * @defgroup CAPI_TELEPHONY_INFORMATION_CALL Call
  46  * @brief The Call API provides functions to check the state of voice and video calls.
  47  *
  48  * @section CAPI_TELEPHONY_INFORMATION_CALL_HEADER Required Header
  49  *   \#include <telephony.h>
  50  *
  51  * @section CAPI_TELEPHONY_INFORMATION_CALL_OVERVIEW Overview
  52  * The Telephony Call API allows you to get the voice and videos call states.
  53  * You can use this information about call related actions.
  54  * @section CAPI_TELEPHONY_INFORMATION_CALL_FEATURE Related Features
  55  * This API is related with the following feature:\n
  56  * - http://tizen.org/feature/network.telephony
  57  *
  58  * It is recommended to design feature related codes in your application for reliability.\n
  59  *
  60  * 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
  61  *
  62  * 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
  63  *
  64  * 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>
  65  */
  66
  67 /**
  68  * @ingroup CAPI_TELEPHONY_INFORMATION
  69  * @defgroup CAPI_TELEPHONY_INFORMATION_NETWORK Network
  70  * @brief The Network Information API provides functions to obtain information about the current telephony service network.
  71  *
  72  * @section CAPI_TELEPHONY_INFORMATION_NETWORK_HEADER Required Header
  73  *   \#include <telephony.h>
  74  *
  75  * @section CAPI_TELEPHONY_INFORMATION_NETWORK_OVERVIEW Overview
  76  * The Telephony Network Information API allows you to access, but not change the
  77  * information about the current cellular network and telephony service.
  78  * @section CAPI_TELEPHONY_INFORMATION_NETWORK_FEATURE Related Features
  79  * This API is related with the following feature:\n
  80  * - http://tizen.org/feature/network.telephony
  81  *
  82  * It is recommended to design feature related codes in your application for reliability.\n
  83  *
  84  * 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
  85  *
  86  * 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
  87  *
  88  * 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>
  89  */
  90
  91 /**
  92  * @ingroup CAPI_TELEPHONY_INFORMATION
  93  * @defgroup CAPI_TELEPHONY_INFORMATION_SIM SIM
  94  * @brief The SIM API provides functions to obtain information from the SIM card, as well as SIM status.
  95  *
  96  * @section CAPI_TELEPHONY_INFORMATION_SIM_HEADER Required Header
  97  *   \#include <telephony.h>
  98  *
  99  * @section CAPI_TELEPHONY_INFORMATION_SIM_OVERVIEW Overview
 100  * The Telephony SIM API allows you to extract information stored on a SIM card, but not change the information.
 101  * @section CAPI_TELEPHONY_INFORMATION_SIM_FEATURE Related Features
 102  * This API is related with the following feature:\n
 103  * - http://tizen.org/feature/network.telephony
 104  *
 105  * It is recommended to design feature related codes in your application for reliability.\n
 106  *
 107  * 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
 108  *
 109  * 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
 110  *
 111  * 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>
 112  */
 113
 114 /**
 115  * @ingroup CAPI_TELEPHONY_INFORMATION
 116  * @defgroup CAPI_TELEPHONY_INFORMATION_MODEM Modem
 117  * @brief The Modem Information API provides functions to obtain information from the modem.
 118  *
 119  * @section CAPI_TELEPHONY_INFORMATION_MODEM_HEADER Required Header
 120  *   \#include <telephony.h>
 121  *
 122  * @section CAPI_TELEPHONY_INFORMATION_MODEM_OVERVIEW Overview
 123  * The Telephony Modem Information API allows you to access, but not change the information about IMEI.
 124  * @section CAPI_TELEPHONY_INFORMATION_MODEM_FEATURE Related Features
 125  * This API is related with the following feature:\n
 126  * - http://tizen.org/feature/network.telephony
 127  *
 128  * It is recommended to design feature related codes in your application for reliability.\n
 129  *
 130  * 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
 131  *
 132  * 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
 133  *
 134  * 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>
 135  */
 136
 137 #endif /* __TIZEN_TELEPHONY_INFORMATION_DOC_H__ */