inc/FTelTypes.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 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  * @file    FTelTypes.h
  19  * @brief   This is the header file for the enumerations of the Telephony namespace.
  20  *
  21  * This header file contains the definitions of the enumerations of the Telephony namespace.
  22  */
  23 #ifndef _FTEL_ENUM_H_
  24 #define _FTEL_ENUM_H_
  25
  26 namespace Tizen { namespace Telephony
  27 {
  28 /**
  29  * @enum    CallType
  30  *
  31  * Defines the type of the current call.
  32  *
  33  * @since   2.0
  34  */
  35 enum CallType
  36 {
  37         TYPE_UNDEFINED_CALL = -1,   /**< No defined type */
  38         TYPE_VOICE_CALL = 0,        /**< The voice call type */
  39         TYPE_VIDEO_CALL             /**< The video call type */
  40 };
  41
  42 /**
  43  * @enum    CallStatus
  44  *
  45  * Defines the current status of calls.
  46  *
  47  * @since   2.0
  48  */
  49 enum CallStatus
  50 {
  51         CALL_STATUS_UNDEFINED = -1, /**< No defined type */
  52         CALL_STATUS_IDLE = 0,       /**< No call is in progress */
  53         CALL_STATUS_ACTIVE,         /**< @if OSPDEPREC @deprecated This enum value is deprecated because an active status is divided into three, that is, communicating, ringing, dialing, and holding @endif */
  54         CALL_STATUS_COMMUNICATING,  /**< Voice or video calls are in progress */
  55         CALL_STATUS_RINGING,        /**< An incoming voice or video call */
  56         CALL_STATUS_DIALING,        /**< An outgoing voice or video call */
  57         CALL_STATUS_HOLDING         /**< A call on holding status */
  58 };
  59
  60 /**
  61  * @enum        SimType
  62  *
  63  * Defines the type of the SIM card.
  64  *
  65  * @since       2.1
  66  */
  67 enum SimType
  68 {
  69         SIM_TYPE_UNKNOWN,                       /**< Unknown card */
  70         SIM_TYPE_GSM,                           /**< GSM SIM card */
  71         SIM_TYPE_USIM,                          /**< Universal SIM card */
  72         SIM_TYPE_RUIM,                          /**< Removable UIM (User Identity Module) */
  73         SIM_TYPE_ISIM                           /**< IMS SIM card */
  74 };
  75
  76 /**
  77  * @enum        SimState
  78  *
  79  * Defines the current state of the SIM card.
  80  *
  81  * @since       2.1
  82  */
  83 enum SimState
  84 {
  85         SIM_STATE_UNKNOWN,                      /**< Unknown state */
  86         SIM_STATE_ABSENT,                       /**< SIM is not present */
  87         SIM_STATE_INITIALIZING,         /**< SIM is in initializing state */
  88         SIM_STATE_READY,                        /**< SIM is in ready state */
  89         SIM_STATE_PIN_REQUIRED,         /**< PIN required */
  90         SIM_STATE_PUK_REQUIRED,         /**< PUK required */
  91         SIM_STATE_NETWORK_LOCKED,       /**< Network locked state */
  92         SIM_STATE_SIM_LOCKED            /**< PH-SIM (phone-SIM) locked state */
  93 };
  94
  95 }} // Tizen::Telephony
  96 #endif // _FTEL_ENUM_H_