/**
* @brief Enumeration for security type of Wi-Fi.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_WIFI_SECURITY_TYPE_NONE = 0, /**< Security disabled */
/**
* @brief Enumeration for encryption modes.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_WIFI_ENCRYPTION_TYPE_NONE = 0, /**< Encryption disabled */
/**
* @brief Enumeration for cellular service type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_CELLULAR_SERVICE_TYPE_UNKNOWN = 0, /**< Unknown */
/**
* @brief Enumeration for cellular authentication type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_CELLULAR_AUTH_TYPE_NONE = 0, /**< No authentication */
/**
* @brief The profile handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef void* connection_profile_h;
/**
* @brief Enumeration for profile state type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_PROFILE_STATE_DISCONNECTED = 0, /**< Disconnected state */
/**
* @brief Enumeration for address family.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_ADDRESS_FAMILY_IPV4 = 0, /**< IPV4 Address type */
/**
* @brief Enumeration for IP configuration type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
/**
/**
* @brief Enumeration for proxy method type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
/**
/**
* @brief Enumeration for network connection type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_PROFILE_TYPE_CELLULAR = 0, /**< Cellular type */
* @brief Creates a profile handle.
* @details The profile name, which you get from connection_profile_get_name()
* will include the keyword you set.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile using connection_profile_destroy().
/**
* @brief Destroys a profile handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[out] profile The handle to the profile
* @return @c 0 on success,
* otherwise a negative error value
* So, you must use this function instead of connection_profile_get_name()
* if you want to get the unique identification.
* In case you create a profile, this value will be determined when you add the profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a profile_id using free().
* @param[in] profile The profile handle
* @param[out] profile_id The ID of the profile
/**
* @brief Gets the profile name.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a profile_name using free().
* @param[in] profile The profile handle
* @param[out] profile_name The name of the profile
/**
* @brief Gets the network type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of the profile
* @return @c 0 on success,
/**
* @brief Gets the name of the network interface, e.g. eth0 and pdp0.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a interface_name using free().
* @param[in] profile The profile handle
* @param[out] interface_name The name of the network interface
/**
* @brief Refreshes the profile information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You should call this function in order to get the current information
/**
* @brief Gets the network state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] state The state of the profile
* @return @c 0 on success,
/**
* @brief Gets the IP config type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] address_family The address family
* @param[out] type The type of the IP config
/**
* @brief Gets the IP address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a ip_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Gets the Subnet Mask.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a subnet_mask using free().
* This function is supported only for IPv4 address family.
* @param[in] profile The profile handle
/**
* @brief Gets the Gateway address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a gateway_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Gets the DNS address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The allowance of the DNS address is @c 2. You must release @a dns_address using free().
* @param[in] profile The profile handle
* @param[in] order The order of DNS address \n
/**
* @brief Gets the Proxy type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of the proxy
* @return @c 0 on success,
/**
* @brief Gets the Proxy address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a proxy_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
* @brief Sets the IP config type.
* @details If you set IP config type to #CONNECTION_IP_CONFIG_TYPE_STATIC,
* then IP address, Gateway and Subnet mask will be set to the initial value "0.0.0.0".
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] address_family The address family
* @param[in] type The type of the IP config
/**
* @brief Sets the IP address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a ip_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Sets the Subnet Mask.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a subnet_mask using free().
* This function is supported only for IPv4 address family.
* @param[in] profile The profile handle
/**
* @brief Sets the Gateway address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a gateway_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Sets the DNS address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The allowance of the DNS address is @c 2.
* @remarks You must release @a dns_address using free().
* @param[in] profile The profile handle
* @brief Sets the Proxy type.
* @details If you set the Proxy type to #CONNECTION_PROXY_TYPE_AUTO or
* #CONNECTION_PROXY_TYPE_MANUAL, then Proxy will be restored.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] type The type of the proxy
* @return @c 0 on success,
/**
* @brief Sets the Proxy address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a proxy_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Called when the state of the profile is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] state The state
* @param[in] user_data The user data passed from the callback registration function
* @see connection_profile_set_state_changed_cb()
/**
* @brief Sets the callback that is called when the state of profile is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @brief Unsets the callback that is called when the state of profile is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the ESSID (Extended Service Set Identifier).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a essid using free().
* @param[in] profile The profile handle
* @param[out] essid The ESSID
/**
* @brief Gets the BSSID (Basic Service Set Identifier).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a bssid using free().
* @param[in] profile The profile handle
* @param[out] bssid The BSSID
/**
* @brief Gets the RSSI.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] rssi The RSSI
* @return @c 0 on success,
/**
* @brief Gets the frequency (MHz).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] frequency The frequency
* @return @c 0 on success,
/**
* @brief Gets the max speed (Mbps).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] max_speed The max speed
* @return @c 0 on success,
/**
* @brief Gets the security type of Wi-Fi.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of Wi-Fi security
* @return @c 0 on success,
/**
* @brief Gets the encryption type of Wi-Fi.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of Wi-Fi security
* @return @c 0 on success,
/**
* @brief Checks whether passphrase is required.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks This function is not valid if security type is #CONNECTION_WIFI_SECURITY_TYPE_EAP.
* @param[in] profile The profile handle
* @param[out] required @c true if a passphrase is required,
/**
* @brief Sets the passphrase of the Wi-Fi WPA.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a passphrase using free().
* @param[in] profile The profile handle
* @param[in] passphrase The passphrase of Wi-Fi security
/**
* @brief Checks whether the WPS (Wi-Fi Protected Setup) is supported.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks If WPS is supported, you can connect the access point with WPS by wifi_connect_with_wps().
* @param[in] profile The profile handle
* @param[out] supported @c true if WPS is supported,
/**
* @brief Gets the service type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of the cellular service
* @return @c 0 on success,
/**
* @brief Gets the APN (access point name).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a apn using free().
* @param[in] profile The profile handle
* @param[out] apn The name of the APN
/**
* @brief Gets the authentication information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a user_name and @a password using free().
* @param[in] profile The profile handle
* @param[out] type The type of the authentication
/**
* @brief Gets the home URL.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a home_url using free().
* @param[in] profile The profile handle
* @param[out] home_url The home URL
/**
* @brief Checks whether the connection is in roaming state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] is_roaming @c true if the cellular is roaming,
* otherwise @c false if it is not roaming
/**
* @brief Checks whether the profile is hidden.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] is_hidden @c true if the profile is in hidden,
* otherwise @c false if the profile is not hidden
/**
* @brief Checks whether the profile is editable.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] is_editable @c true if the profile is editable,
* otherwise @c false if the profile is not editable
/**
* @brief Checks whether the profile is default.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] is_default @c true if the profile is default,
* otherwise @c false if the profile is not default
/**
* @brief Sets the service type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] service_type The type of cellular service
* @return @c 0 on success,
/**
* @brief Sets the APN (Access Point Name).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a apn using free().
* @param[in] profile The profile handle
* @param[in] apn The name of APN
/**
* @brief Sets the Authentication information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a user_name using free().
* @param[in] profile The profile handle
* @param[in] type The type of the authentication
/**
* @brief Sets the home URL.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a home_url using free().
* @param[in] profile The profile handle
* @param[in] home_url The home URL
/**
* @brief The connection handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef void* connection_h;
/**
* @brief The profiles iterator handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef void* connection_profile_iterator_h;
/**
* @brief Enumeration for connection type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_TYPE_DISCONNECTED = 0, /**< Disconnected */
/**
* @brief Enumeration for cellular network state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_CELLULAR_STATE_OUT_OF_SERVICE = 0, /**< Out of service */
/**
* @brief Enumeration for Wi-Fi state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_WIFI_STATE_DEACTIVATED = 0, /**< Wi-Fi is deactivated */
/**
* @brief Enumeration for ethernet state.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
CONNECTION_ETHERNET_STATE_DEACTIVATED = 0, /**< There is no Ethernet profile to open */
/**
* @brief Enumeration for Bluetooth state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_BT_STATE_DEACTIVATED = 0, /**< There is no Bluetooth profile to open */
/**
* @brief Enumeration for connection iterator type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_ITERATOR_TYPE_REGISTERED = 0, /**< The iterator of the registered profile */
/**
* @brief Enumeration for reset profile type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
/**
/**
* @brief Enumeration for the attached or detached state of ethernet cable.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
CONNECTION_ETHERNET_CABLE_DETACHED = 0, /**< Ethernet cable is detached */
/**
* @brief Enumeration for connection errors.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
/**
/**
* @brief Enumeration for statistics type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_STATISTICS_TYPE_LAST_RECEIVED_DATA = 0, /**< Last received data */
* @details If you do not use this function and use other functions,
* you will get the #CONNECTION_ERROR_NOT_INITIALIZED error.
* If you put an invalid handle, you will get the #CONNECTION_ERROR_INVALID_PARAMETER error.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a connection using connection_destroy().
/**
* @brief Destroys the connection handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Called when the type of a connection is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] type The type of the current network connection
* @param[in] user_data The user data passed from the callback registration function
* @see connection_set_type_changed_cb()
/**
* @brief Called when the address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks @a ipv4_address @a ipv6_address should not be freed.
* @a ipv4_address @a ipv6_address is available only in the callback.
* To use outside the callback, make a copy.
/**
* @brief Called when connection_set_default_cellular_service_profile_async() finishes.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The result
* @param[in] user_data The user data passed from connection_open_profile()
* @pre connection_set_default_cellular_service_profile_async() will invoke this callback function.
/**
* @brief Gets the type of the current profile for data connection.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[out] type The type of the network
* @return @c 0 on success,
/**
* @brief Gets the IP address of the current connection.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a ip_address using free().
* @param[in] connection The connection handle
* @param[in] address_family The address family
/**
* @brief Gets the proxy address of the current connection.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a proxy using free().
* @param[in] connection The connection handle
* @param[in] address_family The address family
/**
* @brief Gets the MAC address of the Wi-Fi or ethernet.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @remarks @a mac_addr must be released with free() by you.
* @param[in] connection The handle of the connection
* @param[in] type The type of current network connection
/**
* @brief Gets the state of cellular connection.
* @details The returned state is for the cellular connection state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[out] state The state of the cellular connection
* @return @c 0 on success,
/**
* @brief Gets the state of the Wi-Fi.
* @details The returned state is for the Wi-Fi connection state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The connection handle
/**
* @brief Gets the state of the Ethernet.
* @details The returned state is for the Ethernet connection state.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The connection handle
/**
* @brief Checks for ethernet cable is attached or not.
* @details The returned state is for the ethernet cable state.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The handle of the connection
/**
* @deprecated Deprecated since 4.0. Use connection_ethernet_cable_state_changed_cb() instead.
* @brief Called when ethernet cable is plugged [in/out].
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @param[in] state The state of ethernet cable
* @param[in] user_data The user data passed to callback registration function
*/
/**
* @deprecated Deprecated since 4.0. Use connection_set_ethernet_cable_state_changed_cb() instead.
* @brief Sets callback for ethernet cable is plugged [in/out] event.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @param[in] connection The connection handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @deprecated Deprecated since 4.0. Use connection_unset_ethernet_cable_state_changed_cb() instead.
* @brief Unsets callback for ethernet cable is plugged [in/out] event.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the state of the Bluetooth.
* @details The returned state is for the Bluetooth connection state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The connection handle
/**
* @brief Sets the callback that is called when the type of the current connection is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @brief Unsets the callback that is called when the type of current connection is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Sets the callback that is called when the IP address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @brief Unsets the callback that is called when the IP address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Sets the callback that is called when the proxy address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @brief Unsets the callback that is called when the proxy address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Adds a new profile which is created by connection_profile_create().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile
* @remarks You can only add a profile of the cellular type.
/**
* @brief Removes an existing profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
* When you call this function, your changes affect the Connection Manager
* and the existing profile is updated.
* In addition, the existing profile will be updated if you call connection_open_profile().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
/**
* @brief Gets a profiles iterator.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile_iterator using connection_destroy().
/**
* @brief Moves the profile iterator to the next position and gets a profile handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile_iterator The iterator of profile
* @param[out] profile The profile handle
* @return @c 0 on success,
/**
* @brief Checks whether the next element of a profile iterator exists or not.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The specific error code can be obtained using the get_last_result() method.
* Error codes are described in Exception section.
* @param[in] profile_iterator The iterator of profile
/**
* @brief Destroys a profiles iterator.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile_iterator The iterator of the profile
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the name of the default profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile using connection_profile_destroy().
/**
* @brief Gets the default profile which provides the given cellular service.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile using connection_profile_destroy().
/**
* @brief Sets the default profile which provides the given cellular service.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
/**
* @brief Sets the default profile which provides the given cellular service, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
/**
* @brief Called after connection_open_profile() is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The result
* @param[in] user_data The user data passed from connection_open_profile()
* @pre connection_open_profile() will invoke this callback function.
/**
* @brief Called after connection_close_profile() is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The result
* @param[in] user_data The user data passed from connection_close_profile()
* @pre connection_close_profile() will invoke this callback function.
/**
* @brief Called after connection_reset_profile() is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The result
* @param[in] user_data The user data passed from connection_reset_profile()
* @pre connection_reset_profile() will invoke this callback function.
/**
* @brief Opens a connection of profile, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
* %http://tizen.org/privilege/network.get
/**
* @brief Closes a connection of profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
* @param[in] connection The connection handle
/**
* @brief Resets the cellular profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
* @brief Adds a IPv4 route to the routing table.
* @details You can get the @a interface_name from
* connection_profile_get_network_interface_name() of opened profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel partner
* @privilege %http://tizen.org/privilege/network.route
* @remarks Since 6.0, the required privilege and level of this function has changed.
* @brief Removes a IPv4 route from the routing table.
* @details You can get the @a interface_name from
* connection_profile_get_network_interface_name() of opened profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel partner
* @privilege %http://tizen.org/privilege/network.route
* @remarks Since 6.0, the required privilege and level of this function has changed.
/**
* @brief Gets the statistics information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The connection handle
/**
* @brief Resets the statistics information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
* @param[in] connection The connection handle
/**
* @brief Enumeration for security type of Wi-Fi.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_WIFI_SECURITY_TYPE_NONE = 0, /**< Security disabled */
/**
* @brief Enumeration for encryption modes.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_WIFI_ENCRYPTION_TYPE_NONE = 0, /**< Encryption disabled */
/**
* @brief Enumeration for cellular service type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_CELLULAR_SERVICE_TYPE_UNKNOWN = 0, /**< Unknown */
/**
* @brief Enumeration for cellular authentication type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_CELLULAR_AUTH_TYPE_NONE = 0, /**< No authentication */
/**
* @brief The profile handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef void* connection_profile_h;
/**
* @brief Enumeration for profile state type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_PROFILE_STATE_DISCONNECTED = 0, /**< Disconnected state */
/**
* @brief Enumeration for address family.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_ADDRESS_FAMILY_IPV4 = 0, /**< IPV4 Address type */
/**
* @brief Enumeration for IP configuration type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
/**
/**
* @brief Enumeration for proxy method type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
/**
/**
* @brief Enumeration for network connection type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_PROFILE_TYPE_CELLULAR = 0, /**< Cellular type */
* @brief Creates a profile handle.
* @details The profile name, which you get from connection_profile_get_name()
* will include the keyword you set.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile using connection_profile_destroy().
/**
* @brief Destroys a profile handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[out] profile The handle to the profile
* @return @c 0 on success,
* otherwise a negative error value
* So, you must use this function instead of connection_profile_get_name()
* if you want to get the unique identification.
* In case you create a profile, this value will be determined when you add the profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a profile_id using free().
* @param[in] profile The profile handle
* @param[out] profile_id The ID of the profile
/**
* @brief Gets the profile name.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a profile_name using free().
* @param[in] profile The profile handle
* @param[out] profile_name The name of the profile
/**
* @brief Gets the network type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of the profile
* @return @c 0 on success,
/**
* @brief Gets the name of the network interface, e.g. eth0 and pdp0.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a interface_name using free().
* @param[in] profile The profile handle
* @param[out] interface_name The name of the network interface
/**
* @brief Refreshes the profile information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You should call this function in order to get the current information
/**
* @brief Gets the network state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] state The state of the profile
* @return @c 0 on success,
/**
* @brief Gets the IP config type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] address_family The address family
* @param[out] type The type of the IP config
/**
* @brief Gets the IP address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a ip_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Gets the Subnet Mask.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a subnet_mask using free().
* This function is supported only for IPv4 address family.
* @param[in] profile The profile handle
/**
* @brief Gets the Gateway address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a gateway_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Gets the DNS address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The allowance of the DNS address is @c 2. You must release @a dns_address using free().
* @param[in] profile The profile handle
* @param[in] order The order of DNS address \n
/**
* @brief Gets the Proxy type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of the proxy
* @return @c 0 on success,
/**
* @brief Gets the Proxy address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a proxy_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
* @brief Sets the IP config type.
* @details If you set IP config type to #CONNECTION_IP_CONFIG_TYPE_STATIC,
* then IP address, Gateway and Subnet mask will be set to the initial value "0.0.0.0".
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] address_family The address family
* @param[in] type The type of the IP config
/**
* @brief Sets the IP address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a ip_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Sets the Subnet Mask.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a subnet_mask using free().
* This function is supported only for IPv4 address family.
* @param[in] profile The profile handle
/**
* @brief Sets the Gateway address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a gateway_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Sets the DNS address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The allowance of the DNS address is @c 2.
* @remarks You must release @a dns_address using free().
* @param[in] profile The profile handle
* @brief Sets the Proxy type.
* @details If you set the Proxy type to #CONNECTION_PROXY_TYPE_AUTO or
* #CONNECTION_PROXY_TYPE_MANUAL, then Proxy will be restored.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] type The type of the proxy
* @return @c 0 on success,
/**
* @brief Sets the Proxy address.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a proxy_address using free().
* @param[in] profile The profile handle
* @param[in] address_family The address family
/**
* @brief Called when the state of the profile is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] state The state
* @param[in] user_data The user data passed from the callback registration function
* @see connection_profile_set_state_changed_cb()
/**
* @brief Sets the callback that is called when the state of profile is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @brief Unsets the callback that is called when the state of profile is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the ESSID (Extended Service Set Identifier).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a essid using free().
* @param[in] profile The profile handle
* @param[out] essid The ESSID
/**
* @brief Gets the BSSID (Basic Service Set Identifier).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a bssid using free().
* @param[in] profile The profile handle
* @param[out] bssid The BSSID
/**
* @brief Gets the RSSI.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] rssi The RSSI
* @return @c 0 on success,
/**
* @brief Gets the frequency (MHz).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] frequency The frequency
* @return @c 0 on success,
/**
* @brief Gets the max speed (Mbps).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] max_speed The max speed
* @return @c 0 on success,
/**
* @brief Gets the security type of Wi-Fi.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of Wi-Fi security
* @return @c 0 on success,
/**
* @brief Gets the encryption type of Wi-Fi.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of Wi-Fi security
* @return @c 0 on success,
/**
* @brief Checks whether passphrase is required.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks This function is not valid if security type is #CONNECTION_WIFI_SECURITY_TYPE_EAP.
* @param[in] profile The profile handle
* @param[out] required @c true if a passphrase is required,
/**
* @brief Sets the passphrase of the Wi-Fi WPA.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a passphrase using free().
* @param[in] profile The profile handle
* @param[in] passphrase The passphrase of Wi-Fi security
/**
* @brief Checks whether the WPS (Wi-Fi Protected Setup) is supported.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks If WPS is supported, you can connect the access point with WPS by wifi_connect_with_wps().
* @param[in] profile The profile handle
* @param[out] supported @c true if WPS is supported,
/**
* @brief Gets the service type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] type The type of the cellular service
* @return @c 0 on success,
/**
* @brief Gets the APN (access point name).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a apn using free().
* @param[in] profile The profile handle
* @param[out] apn The name of the APN
/**
* @brief Gets the authentication information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a user_name and @a password using free().
* @param[in] profile The profile handle
* @param[out] type The type of the authentication
/**
* @brief Gets the home URL.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a home_url using free().
* @param[in] profile The profile handle
* @param[out] home_url The home URL
/**
* @brief Checks whether the connection is in roaming state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] is_roaming @c true if the cellular is roaming,
* otherwise @c false if it is not roaming
/**
* @brief Checks whether the profile is hidden.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] is_hidden @c true if the profile is in hidden,
* otherwise @c false if the profile is not hidden
/**
* @brief Checks whether the profile is editable.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] is_editable @c true if the profile is editable,
* otherwise @c false if the profile is not editable
/**
* @brief Checks whether the profile is default.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[out] is_default @c true if the profile is default,
* otherwise @c false if the profile is not default
/**
* @brief Sets the service type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile The profile handle
* @param[in] service_type The type of cellular service
* @return @c 0 on success,
/**
* @brief Sets the APN (Access Point Name).
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a apn using free().
* @param[in] profile The profile handle
* @param[in] apn The name of APN
/**
* @brief Sets the Authentication information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a user_name using free().
* @param[in] profile The profile handle
* @param[in] type The type of the authentication
/**
* @brief Sets the home URL.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a home_url using free().
* @param[in] profile The profile handle
* @param[in] home_url The home URL
/**
* @brief The connection handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef void* connection_h;
/**
* @brief The profiles iterator handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef void* connection_profile_iterator_h;
/**
* @brief Enumeration for connection type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_TYPE_DISCONNECTED = 0, /**< Disconnected */
/**
* @brief Enumeration for cellular network state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_CELLULAR_STATE_OUT_OF_SERVICE = 0, /**< Out of service */
/**
* @brief Enumeration for Wi-Fi state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_WIFI_STATE_DEACTIVATED = 0, /**< Wi-Fi is deactivated */
/**
* @brief Enumeration for ethernet state.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
CONNECTION_ETHERNET_STATE_DEACTIVATED = 0, /**< There is no Ethernet profile to open */
/**
* @brief Enumeration for Bluetooth state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_BT_STATE_DEACTIVATED = 0, /**< There is no Bluetooth profile to open */
/**
* @brief Enumeration for connection iterator type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_ITERATOR_TYPE_REGISTERED = 0, /**< The iterator of the registered profile */
/**
* @brief Enumeration for reset profile type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
/**
/**
* @brief Enumeration for the attached or detached state of ethernet cable.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
CONNECTION_ETHERNET_CABLE_DETACHED = 0, /**< Ethernet cable is detached */
/**
* @brief Enumeration for connection errors.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
/**
/**
* @brief Enumeration for statistics type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
CONNECTION_STATISTICS_TYPE_LAST_RECEIVED_DATA = 0, /**< Last received data */
* @details If you do not use this function and use other functions,
* you will get the #CONNECTION_ERROR_NOT_INITIALIZED error.
* If you put an invalid handle, you will get the #CONNECTION_ERROR_INVALID_PARAMETER error.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a connection using connection_destroy().
/**
* @brief Destroys the connection handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Called when the type of a connection is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] type The type of the current network connection
* @param[in] user_data The user data passed from the callback registration function
* @see connection_set_type_changed_cb()
/**
* @brief Called when the address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks @a ipv4_address @a ipv6_address should not be freed.
* @a ipv4_address @a ipv6_address is available only in the callback.
* To use outside the callback, make a copy.
/**
* @brief Called when connection_set_default_cellular_service_profile_async() finishes.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The result
* @param[in] user_data The user data passed from connection_open_profile()
* @pre connection_set_default_cellular_service_profile_async() will invoke this callback function.
/**
* @brief Gets the type of the current profile for data connection.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[out] type The type of the network
* @return @c 0 on success,
/**
* @brief Gets the IP address of the current connection.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a ip_address using free().
* @param[in] connection The connection handle
* @param[in] address_family The address family
/**
* @brief Gets the proxy address of the current connection.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a proxy using free().
* @param[in] connection The connection handle
* @param[in] address_family The address family
/**
* @brief Gets the MAC address of the Wi-Fi or ethernet.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @remarks @a mac_addr must be released with free() by you.
* @param[in] connection The handle of the connection
* @param[in] type The type of current network connection
/**
* @brief Gets the state of cellular connection.
* @details The returned state is for the cellular connection state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[out] state The state of the cellular connection
* @return @c 0 on success,
/**
* @brief Gets the state of the Wi-Fi.
* @details The returned state is for the Wi-Fi connection state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The connection handle
/**
* @brief Gets the state of the Ethernet.
* @details The returned state is for the Ethernet connection state.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The connection handle
/**
* @brief Checks for ethernet cable is attached or not.
* @details The returned state is for the ethernet cable state.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The handle of the connection
/**
* @deprecated Deprecated since 4.0. Use connection_ethernet_cable_state_changed_cb() instead.
* @brief Called when ethernet cable is plugged [in/out].
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @param[in] state The state of ethernet cable
* @param[in] user_data The user data passed to callback registration function
*/
/**
* @deprecated Deprecated since 4.0. Use connection_set_ethernet_cable_state_changed_cb() instead.
* @brief Sets callback for ethernet cable is plugged [in/out] event.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @param[in] connection The connection handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @deprecated Deprecated since 4.0. Use connection_unset_ethernet_cable_state_changed_cb() instead.
* @brief Unsets callback for ethernet cable is plugged [in/out] event.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the state of the Bluetooth.
* @details The returned state is for the Bluetooth connection state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The connection handle
/**
* @brief Sets the callback that is called when the type of the current connection is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @brief Unsets the callback that is called when the type of current connection is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Sets the callback that is called when the IP address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @brief Unsets the callback that is called when the IP address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Sets the callback that is called when the proxy address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @param[in] callback The callback function to be called
* @param[in] user_data The user data passed to the callback function
/**
* @brief Unsets the callback that is called when the proxy address is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Adds a new profile which is created by connection_profile_create().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile
* @remarks You can only add a profile of the cellular type.
/**
* @brief Removes an existing profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
* When you call this function, your changes affect the Connection Manager
* and the existing profile is updated.
* In addition, the existing profile will be updated if you call connection_open_profile().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
/**
* @brief Gets a profiles iterator.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile_iterator using connection_destroy().
/**
* @brief Moves the profile iterator to the next position and gets a profile handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile_iterator The iterator of profile
* @param[out] profile The profile handle
* @return @c 0 on success,
/**
* @brief Checks whether the next element of a profile iterator exists or not.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The specific error code can be obtained using the get_last_result() method.
* Error codes are described in Exception section.
* @param[in] profile_iterator The iterator of profile
/**
* @brief Destroys a profiles iterator.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] profile_iterator The iterator of the profile
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the name of the default profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile using connection_profile_destroy().
/**
* @brief Gets the default profile which provides the given cellular service.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @remarks You must release @a profile using connection_profile_destroy().
/**
* @brief Sets the default profile which provides the given cellular service.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
/**
* @brief Sets the default profile which provides the given cellular service, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
/**
* @brief Called after connection_open_profile() is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The result
* @param[in] user_data The user data passed from connection_open_profile()
* @pre connection_open_profile() will invoke this callback function.
/**
* @brief Called after connection_close_profile() is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The result
* @param[in] user_data The user data passed from connection_close_profile()
* @pre connection_close_profile() will invoke this callback function.
/**
* @brief Called after connection_reset_profile() is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The result
* @param[in] user_data The user data passed from connection_reset_profile()
* @pre connection_reset_profile() will invoke this callback function.
/**
* @brief Opens a connection of profile, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
* %http://tizen.org/privilege/network.get
/**
* @brief Closes a connection of profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
* @param[in] connection The connection handle
/**
* @brief Resets the cellular profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
* %http://tizen.org/privilege/network.get
* @brief Adds a IPv4 route to the routing table.
* @details You can get the @a interface_name from
* connection_profile_get_network_interface_name() of opened profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel partner
* @privilege %http://tizen.org/privilege/network.route
* @remarks Since 6.0, the required privilege and level of this function has changed.
* @brief Removes a IPv4 route from the routing table.
* @details You can get the @a interface_name from
* connection_profile_get_network_interface_name() of opened profile.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel partner
* @privilege %http://tizen.org/privilege/network.route
* @remarks Since 6.0, the required privilege and level of this function has changed.
/**
* @brief Gets the statistics information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
* @param[in] connection The connection handle
/**
* @brief Resets the statistics information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
* @param[in] connection The connection handle