From: Wootak Jung Date: Wed, 23 Mar 2016 05:26:01 +0000 (+0900) Subject: Update API version description X-Git-Tag: submit/tizen/20160324.235501~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F85%2F63285%2F1;p=platform%2Fcore%2Fapi%2Ftelephony.git Update API version description Change-Id: I923413fa82565a6a9d718370901deaf3913f9d19 --- diff --git a/include/telephony_call.h b/include/telephony_call.h index 1d30047..1a885db 100644 --- a/include/telephony_call.h +++ b/include/telephony_call.h @@ -35,12 +35,12 @@ extern "C" { /** * @brief The call handle. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef struct telephony_call_info_s *telephony_call_h; /** - * @deprecated Deprecated Since 2.4. Use #telephony_call_status_e instead. + * @deprecated Deprecated Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #telephony_call_status_e instead. * * @brief Enumeration for the call state. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif @@ -53,7 +53,7 @@ typedef enum { /** * @brief Enumeration for the call status. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_CALL_STATUS_IDLE, /**< Idle status */ @@ -66,7 +66,7 @@ typedef enum { /** * @brief Enumeration for the preferred voice call subscription. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_CALL_PREFERRED_VOICE_SUBS_UNKNOWN = -1, /**< Unknown status */ @@ -78,7 +78,7 @@ typedef enum { /** * @brief Enumeration for the call type. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_CALL_TYPE_VOICE, /**< Voice call */ @@ -88,7 +88,7 @@ typedef enum { /** * @brief Enumeration for the call direction. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_CALL_DIRECTION_MO, /**< MO(Mobile Originated) call */ @@ -96,7 +96,7 @@ typedef enum { } telephony_call_direction_e; /** - * @deprecated Deprecated Since 2.4. Use #telephony_call_get_status instead. + * @deprecated Deprecated Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #telephony_call_get_status instead. * * @brief Gets the voice call state of the telephony service. * @details Determines if the voice call is connecting, connected, or idle. @@ -125,7 +125,7 @@ typedef enum { int telephony_call_get_voice_call_state(telephony_h handle, telephony_call_state_e *call_state); /** - * @deprecated Deprecated Since 2.4. Use #telephony_call_get_status instead. + * @deprecated Deprecated Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #telephony_call_get_status instead. * * @brief Gets the video call state of the telephony service. * @details Determines if the video call is connecting, connected, or idle. @@ -156,7 +156,7 @@ int telephony_call_get_video_call_state(telephony_h handle, telephony_call_state /** * @brief Gets the current value for the preferred voice call subscription. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/telephony * @@ -178,7 +178,7 @@ int telephony_call_get_preferred_voice_subscription(telephony_h handle, telephon /** * @brief Gets the list of the current call. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/telephony * @@ -203,7 +203,7 @@ int telephony_call_get_call_list(telephony_h handle, /** * @brief Releases the list allocated from #telephony_call_get_call_list() * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @param[in] count The count of the calls from #telephony_call_get_call_list() * @param[in] call_list The handle from #telephony_call_get_call_list() @@ -222,7 +222,7 @@ int telephony_call_release_call_list(unsigned int count, telephony_call_h **call /** * @brief Gets the call handle ID. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @param[in] call_handle The handle from #telephony_call_get_call_list() * @param[out] handle_id The id of the call handle @@ -242,7 +242,7 @@ int telephony_call_get_handle_id(telephony_call_h call_handle, unsigned int *han /** * @brief Gets the call number. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @remarks You must release @c number using free() on success case. * @@ -264,7 +264,7 @@ int telephony_call_get_number(telephony_call_h call_handle, char **number); /** * @brief Gets the call type. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @param[in] call_handle The handle from #telephony_call_get_call_list() * @param[out] type The type of the call (#telephony_call_type_e) @@ -284,7 +284,7 @@ int telephony_call_get_type(telephony_call_h call_handle, telephony_call_type_e /** * @brief Gets the call status. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @param[in] call_handle The handle from #telephony_call_get_call_list() * @param[out] status The status of the call (#telephony_call_status_e) @@ -303,7 +303,7 @@ int telephony_call_get_status(telephony_call_h call_handle, telephony_call_statu /** * @brief Gets whether the call is MO(Mobile Originated) call or MT(Mobile Terminated). - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @param[in] call_handle The handle from #telephony_call_get_call_list() * @param[out] direction The direction of the call (#telephony_call_direction_e) @@ -322,7 +322,7 @@ int telephony_call_get_direction(telephony_call_h call_handle, telephony_call_di /** * @brief Gets whether the call is conference call or not. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @param[in] call_handle The handle from #telephony_call_get_call_list() * @param[out] conference_status The value whether the call is conference call or not. diff --git a/include/telephony_common.h b/include/telephony_common.h index 8994043..1f50d45 100644 --- a/include/telephony_common.h +++ b/include/telephony_common.h @@ -95,16 +95,16 @@ typedef enum { '#telephony_network_rssi_e' will be delivered in notification data @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_NETWORK_NETWORK_NAME, /**< Notification to be invoked when the network name changes. @n - 'network_name(char *)' wil be delivered in notification data (@b Since: 2.4) @n + 'network_name(char *)' wil be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_NETWORK_PS_TYPE, /**< Notification to be invoked when the ps type changes. @n - '#telephony_network_ps_type_e' will be delivered in notification data (@b Since: 2.4) @n + '#telephony_network_ps_type_e' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_NETWORK_DEFAULT_DATA_SUBSCRIPTION, /**< Notification to be invoked when the default data subscription changes. @n - '#telephony_network_default_data_subs_e' wil be delivered in notification data (@b Since: 2.4) @n + '#telephony_network_default_data_subs_e' wil be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_NETWORK_DEFAULT_SUBSCRIPTION, /**< Notification to be invoked when the default subscription changes. @n - '#telephony_network_default_subs_e' will be delivered in notification data (@b Since: 2.4) @n + '#telephony_network_default_subs_e' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_NETWORK_LAC, /**< Notification to be invoked when the LAC (Location Area Code) changes. @n 'lac(int)' will be delivered in notification data (@b Since: 3.0) @n @@ -129,46 +129,46 @@ typedef enum { Privilege : http://tizen.org/privilege/location.coarse */ TELEPHONY_NOTI_VOICE_CALL_STATE = 0x30, /**< Notification to be invoked when the voice call state changes. @n - '#telephony_call_state_e' will be delivered in notification data (Deprecated Since 2.4. Use #TELEPHONY_NOTI_VOICE_CALL_STATUS_XXX instead.) @n + '#telephony_call_state_e' will be delivered in notification data (Deprecated Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #TELEPHONY_NOTI_VOICE_CALL_STATUS_XXX instead.) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VIDEO_CALL_STATE, /**< Notification to be invoked when the video call state changes. @n - '#telephony_call_state_e' will be delivered in notification data (Deprecated Since 2.4. Use #TELEPHONY_NOTI_VIDEO_CALL_STATUS_XXX instead.) @n + '#telephony_call_state_e' will be delivered in notification data (Deprecated Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #TELEPHONY_NOTI_VIDEO_CALL_STATUS_XXX instead.) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VOICE_CALL_STATUS_IDLE, /**< Notification to be invoked when a voice call is in idle status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VOICE_CALL_STATUS_ACTIVE, /**< Notification to be invoked when a voice call is in active status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VOICE_CALL_STATUS_HELD, /**< Notification to be invoked when a voice call is in held status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VOICE_CALL_STATUS_DIALING, /**< Notification to be invoked when a voice call is in dialing status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VOICE_CALL_STATUS_ALERTING, /**< Notification to be invoked when a voice call is in alertingstatus. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VOICE_CALL_STATUS_INCOMING, /**< Notification to be invoked when a voice call is in incoming status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VIDEO_CALL_STATUS_IDLE, /**< Notification to be invoked when a video call is in idle status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VIDEO_CALL_STATUS_ACTIVE, /**< Notification to be invoked when a video call is in active status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VIDEO_CALL_STATUS_DIALING, /**< Notification to be invoked when a video call is in dialing status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VIDEO_CALL_STATUS_ALERTING, /**< Notification to be invoked when a video call is in alerting status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_VIDEO_CALL_STATUS_INCOMING, /**< Notification to be invoked when a video call is in incoming status. @n - 'handle_id(unsigned int)' will be delivered in notification data (@b Since: 2.4) @n + 'handle_id(unsigned int)' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ TELEPHONY_NOTI_CALL_PREFERRED_VOICE_SUBSCRIPTION /**< Notification to be invoked when the preferred voice subscription changes. @n - '#telephony_call_preferred_voice_subs_e' will be delivered in notification data (@b Since: 2.4) @n + '#telephony_call_preferred_voice_subs_e' will be delivered in notification data (@b Since: @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @n Privilege : http://tizen.org/privilege/telephony */ } telephony_noti_e; @@ -271,7 +271,7 @@ int telephony_deinit(telephony_handle_list_s *list); /** * @brief Enumeration for the telephony state. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_STATE_NOT_READY, /**< Telephony state is not ready */ @@ -280,14 +280,14 @@ typedef enum { /** * @brief Called for the telephony state changes. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef void (*telephony_state_changed_cb)(telephony_state_e state, void *user_data); /** * @brief Acquires the telephony state value * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @param[out] state The state value of telephony. * @@ -307,7 +307,7 @@ int telephony_get_state(telephony_state_e *state); /** * @brief Sets a callback function to be invoked when the telephony state changes. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @param[in] callback The callback to be invoked when the telephony state changes * @param[in] user_data The user data passed to the callback function @@ -329,7 +329,7 @@ int telephony_set_state_changed_cb(telephony_state_changed_cb callback, void *us /** * @brief Unsets a telephony state callback function. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * * @param[in] callback The callback to unset when the telephony state changes * diff --git a/include/telephony_modem.h b/include/telephony_modem.h index 9bafd15..ad81859 100644 --- a/include/telephony_modem.h +++ b/include/telephony_modem.h @@ -35,7 +35,7 @@ extern "C" { /** * @brief Enumeration for Modem Power Status. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_MODEM_POWER_STATUS_UNKNOWN = -1, /**< Unknown */ @@ -73,7 +73,7 @@ int telephony_modem_get_imei(telephony_h handle, char **imei); /** * @brief Gets the power status of the modem * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/telephony * diff --git a/include/telephony_network.h b/include/telephony_network.h index dfba9d6..106d57e 100644 --- a/include/telephony_network.h +++ b/include/telephony_network.h @@ -73,7 +73,7 @@ typedef enum { /** * @brief Enumeration for PS Type. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_NETWORK_PS_TYPE_UNKNOWN, /**< Unknown */ @@ -95,7 +95,7 @@ typedef enum { /** * @brief Enumeration for Network Name Priority. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_NETWORK_NAME_OPTION_UNKNOWN, /**< Unknown */ @@ -106,7 +106,7 @@ typedef enum { /** * @brief Enumeration for the possible 'default' Data Subscriptions for Packet Switched(PS). - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_NETWORK_DEFAULT_DATA_SUBS_UNKNOWN = -1, /**< Unknown status */ @@ -116,7 +116,7 @@ typedef enum { /** * @brief Enumeration defines possible 'default' Subscriptions for Circuit Switched(CS). - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_NETWORK_DEFAULT_SUBS_UNKNOWN = -1, /**< Unknown status */ @@ -336,7 +336,7 @@ int telephony_network_get_type(telephony_h handle, /** * @brief Gets the packet service type of the current registered network. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/telephony * @@ -362,7 +362,7 @@ int telephony_network_get_ps_type(telephony_h handle, telephony_network_ps_type_ /** * @brief Gets the network name option of the current registered network. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/telephony * @@ -408,7 +408,7 @@ int telephony_network_get_service_state(telephony_h handle, /** * @brief Gets the current default subscription for data service (Packet Switched). * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/telephony * @@ -431,7 +431,7 @@ int telephony_network_get_default_data_subscription(telephony_h handle, /** * @brief Gets the current default subscription for voice service (Circuit Switched). * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/telephony * diff --git a/include/telephony_private.h b/include/telephony_private.h index 63df3eb..20c7487 100644 --- a/include/telephony_private.h +++ b/include/telephony_private.h @@ -51,7 +51,7 @@ /** * @brief Definition for the max length of call number - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define TELEPHONY_CALL_NUMBER_LEN_MAX 82 @@ -78,7 +78,7 @@ struct tapi_handle { /** * @brief The structure type for the call information. - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef struct { unsigned int id; /**< The handle of the call */ diff --git a/include/telephony_sim.h b/include/telephony_sim.h index 9614af0..2439ff1 100644 --- a/include/telephony_sim.h +++ b/include/telephony_sim.h @@ -58,7 +58,7 @@ typedef enum { /** * @brief Enumeration for the type of SIM card . - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { TELEPHONY_SIM_APP_TYPE_SIM = 0x01, /**< SIM(GSM) Application */ @@ -236,7 +236,7 @@ int telephony_sim_get_state(telephony_h handle, telephony_sim_state_e *sim_state /** * @brief Gets the list of application on UICC. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/telephony * @@ -298,7 +298,7 @@ int telephony_sim_get_subscriber_number(telephony_h handle, char **subscriber_nu * @brief Gets the Subscriber ID. * @details This function gets subscriber ID encoded. * - * @since_tizen 2.4 + * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/telephony * @@ -375,7 +375,7 @@ int telephony_sim_get_lock_state(telephony_h handle, telephony_sim_lock_state_e int telephony_sim_get_group_id1(telephony_h handle, char **gid1); /** - * @brief Gets the call fowarding indicator state of the SIM. + * @brief Gets the call forwarding indicator state of the SIM. * @details If the state is true, incoming call will be forwarded to selected number. * @c state indicates the CFU (Call Forwarding Unconditional) indicator status - Voice. * (3GPP TS 31.102 4.2.64 EF CFIS) diff --git a/packaging/capi-telephony.spec b/packaging/capi-telephony.spec index 99f7fdc..29e68f3 100644 --- a/packaging/capi-telephony.spec +++ b/packaging/capi-telephony.spec @@ -1,6 +1,6 @@ Name: capi-telephony Summary: Telephony Core API -Version: 0.1.61 +Version: 0.1.62 Release: 1 Group: System/Libraries License: Apache-2.0