/**
* @brief Called for each found access point.
+ * @details This callback function is used in conjunction with `wifi_manager_foreach_found_ap()` or `wifi_manager_foreach_found_specific_ap()` to iterate through all discovered access points.
* @since_tizen 3.0
* @remarks @a ap is valid only in this function. In order to use @a ap outside this function, you must copy the @a ap with wifi_manager_ap_clone().
* @param[in] ap The access point
/**
* @brief Called when the scanning state is changed.
+ * @details This callback function is registered using `wifi_manager_set_scan_state_changed_cb()` and will be called whenever the scanning state of the Wi-Fi manager changes.
* @since_tizen 4.0
* @param[in] state The wifi scanning state
* @param[in] user_data The user data passed from the callback registration function
/**
* @brief Called when the device state is changed.
+ * @details This callback function is registered using `wifi_manager_set_device_state_changed_cb()` and will be called whenever the state of the Wi-Fi device changes.
* @since_tizen 3.0
* @param[in] state The device state
* @param[in] user_data The user data passed from the callback registration function
/**
* @brief Called when the connection state is changed.
+ * @details This callback function is registered using `wifi_manager_set_connection_state_changed_cb()` and will be called whenever the connection state of a Wi-Fi access point changes.
* @since_tizen 3.0
* @param[in] state The connection state
* @param[in] ap The access point
/**
* @brief Called when the IP conflict state is changed.
+ * @details This callback function is registered using `wifi_manager_set_ip_conflict_cb()` and will be called whenever the IP conflict state changes.
* @since_tizen 5.0
* @remarks @a mac should not be freed. @a mac is available only in the callback. To use
* outside the callback, make a copy.
/**
* @brief Called when the RSSI of connected Wi-Fi is changed.
+ * @details This callback function is registered using `wifi_manager_set_rssi_level_changed_cb()` and will be called whenever the RSSI level of the connected Wi-Fi network changes.
* @since_tizen 3.0
* @param[in] rssi_level The level of RSSI
* @param[in] user_data The user data passed from the callback registration function
/**
* @brief Called when the Wi-Fi Module state is changed.
+ * @details This callback function is registered using `wifi_manager_set_module_state_changed_cb()` and will be called whenever the state of the Wi-Fi module changes.
* @since_tizen 4.0
* @param[in] wifi_module_state The Wi-Fi Module state
* @param[in] user_data The user data passed from the callback registration function
/**
* @brief Called for each found access point configuration.
+ * @details This callback function is used in conjunction with `wifi_manager_config_foreach_configuration()` to iterate through all saved access point configurations.
* @since_tizen 3.0
* @remarks @a config is valid only in this function. In order to use @a config outside this function, you must copy the config with wifi_manager_config_clone().
*
/**
* @brief Called when the Wi-Fi TDLS state is changed.
+ * @details This callback function is registered using `wifi_manager_tdls_set_state_changed_cb()` and
+ * will be called whenever the state of a TDLS connection changes.
* @since_tizen 3.0
*
* @param[in] state The TDLS state
/**
* @brief Called when the Wi-Fi TDLS is discovered.
+ * @details This callback function is registered using `wifi_manager_tdls_set_discovered_cb()` and
+ * will be called when the TDLS discovery process is completed.
* @since_tizen 4.0
* @remarks @a peer_mac_addr is usable only in the callback. To use outside the callback, make a copy.
* @param[in] state The TDLS state
*/
/**
- * @brief Initializes Wi-Fi.
+ * @brief Initializes the Wi-Fi service and prepares it for use.
+ * @details This function initializes the Wi-Fi service,
+ * allocating necessary resources and preparing it for subsequent Wi-Fi management operations such as scanning for networks,
+ * connecting to a network, or retrieving Wi-Fi information.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
int wifi_manager_initialize(wifi_manager_h *wifi);
/**
- * @brief Deinitializes Wi-Fi.
+ * @brief Terminates the Wi-Fi service and releases all resources associated with it.
+ * @details This function deinitializes the Wi-Fi service, releasing all allocated resources and terminating any ongoing operations related to Wi-Fi management.
* @since_tizen 3.0
* @param[in] wifi The Wi-Fi handle
* @return 0 on success, otherwise negative error value
/**
* @brief Activates Wi-Fi asynchronously.
+ * @details This function initiates the process to activate the Wi-Fi service.
+ * When Wi-Fi is activated, the Wi-Fi radio is turned on,
+ * and the device becomes capable of connecting to wireless networks.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Activates Wi-Fi asynchronously and displays Wi-Fi picker (popup) when Wi-Fi is not automatically connected.
+ * @details This function activates the Wi-Fi service and, if Wi-Fi does not automatically connect to a known network,
+ * it will display a Wi-Fi picker (popup) allowing the user to manually select a network to connect to.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Deactivates Wi-Fi asynchronously.
+ * @details This function initiates the process to deactivate the Wi-Fi service. When Wi-Fi is deactivated,
+ * the Wi-Fi radio is turned off, and the device will no longer be able to connect to wireless networks.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Checks whether Wi-Fi is activated.
+ * @details This function checks the status of the Wi-Fi service to determine if it is currently activated.
+ * If Wi-Fi is activated, it means that the Wi-Fi radio is turned on and ready to connect to wireless networks.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Gets the local MAC address.
+ * @details This function queries the Wi-Fi manager to obtain the MAC address of the Wi-Fi device.
+ * The MAC address is a unique identifier assigned to network interfaces for communications on a physical network segment.
* @since_tizen 3.0
* @remarks You must release @a mac_address using free().
* @param[in] wifi The Wi-Fi handle
/**
* @brief Gets the name of the network interface.
+ * @details This function queries the Wi-Fi manager to obtain the name of the network interface that is currently being used for the Wi-Fi connection.
+ * The network interface name is typically a string identifier like 'wlan0' or 'eth0', which can be used for various networking operations.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Starts scan asynchronously.
+ * @details This function starts a Wi-Fi scan to discover all available access points (APs) in the vicinity.
+ * The scan results will include information about each detected AP, such as its SSID, signal strength, and security type.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Gets the Wi-Fi scan state.
+ * @details This function queries the Wi-Fi manager to determine the current state of the Wi-Fi scan operation.
+ * The scan state indicates whether a scan is currently in progress or if the results from the last scan are still valid.
* @since_tizen 4.0
* @param[in] wifi The Wi-Fi handle
* @param[in] scan_state The Wi-Fi scan state
/**
* @brief Starts specific AP scan, asynchronously.
+ * @details This function starts a Wi-Fi scan targeting a specific access point (AP) with the given ESSID (Extended Service Set Identifier).
+ * Unlike a regular scan, which searches for all available APs in the vicinity, a specific scan focuses on a single AP with the specified ESSID,
+ * potentially improving scan performance and reducing scan time.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Creates a Wi-Fi specific AP scan handle.
+ * @details This function creates a new specific AP scan handle, which can be used to configure and initiate specific AP scans.
+ * The handle is required for setting up specific scan parameters such as SSID and channel frequency.
* @since_tizen 4.0
* @remarks You must release @a specific_scan using wifi_manager_specific_scan_destroy().
* @param[in] wifi The Wi-Fi handle
/**
* @brief Destroys a Wi-Fi specific AP scan handle.
+ * @details This function releases the memory allocated for a specific AP scan handle,
+ * which was created using `wifi_manager_specific_scan_create()`.
+ * It is important to destroy the handle when it is no longer needed to avoid memory leaks.
* @since_tizen 4.0
* @param[in] wifi The Wi-Fi handle
* @param[in] specific_scan The Wi-Fi specific AP scan handle
/**
* @brief Gets the maximum number of SSIDs supported by the Wi-Fi chipset for the scan operation.
+ * @details This function queries the Wi-Fi manager to determine the maximum number of SSIDs that the Wi-Fi chipset can support during a single scan operation.
+ * This value is important when configuring specific AP scans, as it limits the number of SSIDs that can be targeted in a single scan request.
* @since_tizen 5.5
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Sets the SSID of a specific AP scan.
+ * @details This function sets the SSID for a specific AP scan, which determines the target access point to be scanned.
+ * By specifying the SSID, the scan can focus on a particular AP rather than scanning for all available APs in the vicinity,
+ * potentially improving scan performance and reducing scan time.
* @since_tizen 4.0
* @param[in] specific_scan The Wi-Fi specific AP scan handle
* @param[in] essid The SSID of specific AP scan
/**
* @brief Sets the channel frequency of a specific AP scan.
+ * @details This function sets the channel frequency for a specific AP scan, which determines the radio frequency band on which the scan will be performed.
+ * By specifying the channel frequency, the scan can be focused on a particular frequency band, potentially improving scan performance and reducing scan time.
* @since_tizen 4.0
* @param[in] specific_scan The Wi-Fi specific AP scan handle
* @param[in] freq The channel frequency of specific AP scan
/**
* @brief Starts multi SSID and multi channel specific scan, asynchronously.
+ * @details This function starts a Wi-Fi scan targeting multiple specific access points (APs) across multiple channels simultaneously.
+ * Unlike a regular scan, which searches for all available APs in the vicinity,
+ * a specific scan focuses on a predefined set of APs, which can improve scan efficiency and reduce scan time.
+ * The multi-SSID and multi-channel specific scan extends this concept further by allowing the scan to target multiple sets of APs across different channels at once.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Flushes BSS entries from the cache.
+ * @details This function removes all previously discovered BSS entries from the Wi-Fi manager's internal cache.
+ * BSS entries include information about nearby Wi-Fi access points (APs) that have been scanned and stored by the Wi-Fi manager.
+ * By flushing these entries, the Wi-Fi manager effectively forgets about previously discovered APs,
+ * which can be useful in scenarios where the environment has changed significantly or when privacy concerns dictate that old scan results should be discarded.
* @since_tizen 7.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Connects to the hidden AP, asynchronously.
+ * @details This function attempts to connect to a hidden Wi-Fi access point (AP) with the specified ESSID, security type, and passphrase.
+ * Hidden APs do not broadcast their presence, so the ESSID must be explicitly provided to the function.
+ * The connection process is performed asynchronously, meaning that the function returns immediately,
+ * and the result of the connection attempt is reported via the provided callback function.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Gets the handle of the connected access point.
+ * @details This function retrieves the handle of the access point to which the Wi-Fi interface is currently connected.
+ * If there is no active connection, the function will return an error.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Gets the result of the scan.
+ * @details This function iterates through the list of access points found during a general Wi-Fi scan and provides their details to the caller via the provided callback function.
+ * A general Wi-Fi scan searches for all available access points in the vicinity, regardless of whether they are known or unknown to the device.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Gets the result of specific AP scan.
+ * @details This function iterates through the list of access points found during a specific access point scan
+ * and provides their details to the caller via the provided callback function.
+ * A specific access point scan is used to focus on a particular access point,
+ * rather than scanning all available access points in the vicinity.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Gets the result of the BSSID scan (i.e. BSSID, ESSID & RSSI).
+ * @details This function iterates through the list of access points found during a BSSID scan and provides their details to the caller via the provided callback function.
+ * The BSSID scan focuses on identifying access points based on their unique MAC addresses (BSSID), allowing for more precise identification compared to a regular scan.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Connects to the access point asynchronously.
+ * @details This function initiates a connection to the specified Wi-Fi access point.
+ * The connection process is performed asynchronously, meaning that the function returns immediately,
+ * and the result of the connection attempt is reported via the provided callback function.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Disconnects to the access point asynchronously.
+ * @details This function disrupts the existing connection to the specified Wi-Fi access point.
+ * The disconnection process is performed asynchronously, meaning that the function returns immediately,
+ * and the result of the disconnection attempt is reported via the provided callback function.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Connects to the access point with WPS PBC asynchronously.
+ * @details This function initiates a connection to a Wi-Fi access point using WPS PBC authentication.
+ * The connection process is performed asynchronously, meaning that the function returns immediately,
+ * and the result of the connection attempt is reported via the provided callback function.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
/**
* @brief Connects to the access point with WPS PIN asynchronously.
+ * @details This function initiates a connection to a Wi-Fi access point using WPS PIN authentication.
+ * The connection process is performed asynchronously, meaning that the function returns immediately,
+ * and the result of the connection attempt is reported via the provided callback function.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
/**
* @brief Connects to the access point with WPS PBC without entering SSID.
+ * @details This function initiates a connection to a Wi-Fi access point using WPS PBC authentication.
+ * The SSID of the access point does not need to be known;
+ * the Wi-Fi module will search for and connect to the access point based on the WPS PBC signal.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Connects to the access point with WPS PIN without entering SSID.
+ * @details This function initiates a connection to a Wi-Fi access point using WPS PIN authentication.
+ * The SSID of the access point does not need to be known;
+ * the Wi-Fi module will search for and connect to the access point based on the provided WPS PIN.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Stops ongoing WPS provisioning / disconnects from the connected access point.
+ * @details This function stops any ongoing WPS provisioning process initiated by `wifi_manager_start_wps()` or disconnects
+ * from the currently connected access point if there is no ongoing WPS provisioning.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Gets the WPS generated PIN code.
+ * @details This function queries the Wi-Fi manager to obtain the WPS-generated PIN code.
+ * The retrieved PIN code can be used for WPS-based authentication when connecting to a Wi-Fi access point.
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Deletes stored access point's information and disconnects from it if connected, asynchronously.
+ * @details This function initiates an asynchronous process to delete the stored information of the specified access point and disconnect from it if currently connected.
+ * The result of the operation is reported via the provided callback function.
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
/**
* @brief Updates an existing AP.
* @details When a AP is changed, these changes will be not applied to the Connection Manager immediately.
- * When you call this function, your changes affect the Connection Manager and the existing AP is updated.
+ * When you call this function, your changes affect the Connection Manager and the existing AP is updated.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile \n
/**
* @brief Adds the Wi-Fi Vendor Specific Information Element (VSIE) to a specific frame type.
+ * @details This function adds the specified VSIE data to the given frame ID.
+ * The VSIE data will be included in the corresponding frame when transmitted by the Wi-Fi module.
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
/**
* @brief Gets the Wi-Fi Vendor Specific Information Elements (VSIE) from a specific frame.
+ * @details This function retrieves the VSIE data associated with the given frame ID.
+ * The retrieved VSIE data can be used to inspect or modify the contents of the VSIE element within the specified frame.
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Removes the Wi-Fi Vendor Specific Information Element (VSIE) from specific frame.
+ * @details This function removes the specified VSIE data from the given frame ID.
+ * The VSIE data will no longer be included in the corresponding frame when transmitted by the Wi-Fi module.
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
/**
* @brief Gets the connection state.
+ * @details This function queries the Wi-Fi manager to obtain the current connection state of the Wi-Fi network associated with the given Wi-Fi handle.
+ * The retrieved connection state can be one of the following: DISCONNECTED, CONNECTED, or CONNECTING.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Registers the callback called when the device state is changed.
+ * @details This function registers a callback function to monitor changes in the Wi-Fi device state.
+ * When the Wi-Fi device state changes (e.g., enabled, disabled, or enabling/disabling in progress),
+ * the registered callback function will be invoked with the updated device state and the provided user data.
* @since_tizen 3.0
* @param[in] wifi The Wi-Fi handle
* @param[in] callback The callback function to be called
/**
* @brief Unregisters the callback called when the device state is changed.
+ * @details This function removes the previously registered callback for monitoring changes in the Wi-Fi device state.
+ * The callback will no longer be invoked when the device state changes after this function is called.
* @since_tizen 3.0
* @param[in] wifi The Wi-Fi handle
* @return 0 on success, otherwise negative error value
/**
* @brief Registers the callback called when the background scan is finished.
+ * @details This function registers a callback function to monitor the completion of background scans initiated by the Wi-Fi manager.
+ * When a background scan finishes, the registered callback function will be invoked with the scan results and the provided user data.
* @since_tizen 3.0
* @param[in] wifi The Wi-Fi handle
* @param[in] callback The callback function to be called
/**
* @brief Unregisters the callback called when the scan is finished.
+ * @details This function removes the previously registered callback for monitoring the completion of background scans initiated by the Wi-Fi manager.
+ * The callback will no longer be invoked when a background scan finishes after this function is called.
* @since_tizen 3.0
* @param[in] wifi The Wi-Fi handle
* @return 0 on success, otherwise negative error value
/**
* @brief Registers the callback called when the scanning state is changed.
+ * @details This function registers a callback function to monitor changes in the scanning state of the Wi-Fi network.
+ * When the scanning state changes (e.g., scan started or scan finished),
+ * the registered callback function will be invoked with the updated scanning state and the provided user data.
* @since_tizen 4.0
* @param[in] wifi The Wi-Fi handle
* @param[in] callback The callback function to be called
/**
* @brief Unregisters the callback called when the scanning state is changed.
+ * @details This function removes the previously registered callback for monitoring changes in the scanning state of the Wi-Fi network.
+ * The callback will no longer be invoked when the scanning state changes after this function is called.
* @since_tizen 4.0
* @param[in] wifi The Wi-Fi handle
* @return 0 on success, otherwise negative error value
/**
* @brief Registers the callback called when the connection state is changed.
+ * @details This function registers a callback function to monitor changes in the connection state of the Wi-Fi network.
+ * When the connection state changes (e.g., connected, disconnected, or connection failure),
+ * the registered callback function will be invoked with the updated connection state and the provided user data.
* @since_tizen 3.0
* @param[in] wifi The Wi-Fi handle
* @param[in] callback The callback function to be called
/**
* @brief Unregisters the callback called when the connection state is changed.
+ * @details This function removes the previously registered callback for monitoring changes in the connection state of the Wi-Fi network.
+ * The callback will no longer be invoked when the connection state changes after this function is called.
* @since_tizen 3.0
* @param[in] wifi The Wi-Fi handle
* @return 0 on success, otherwise negative error value
/**
* @brief Registers callback called when the RSSI of connected Wi-Fi is changed.
+ * @details This function registers a callback function to monitor changes in the Received Signal Strength Indication (RSSI) level of the currently connected Wi-Fi network.
+ * When the RSSI level changes, the registered callback function will be invoked with the updated RSSI level and the provided user data.
* @since_tizen 3.0
* @param[in] wifi The Wi-Fi handle
* @param[in] callback The callback function to be called
/**
* @brief Unregisters callback called when the RSSI of connected Wi-Fi is changed.
+ * @details This function removes the previously registered callback for monitoring changes in the Received Signal Strength Indication (RSSI) level of the currently connected Wi-Fi network.
+ * The callback will no longer be invoked when the RSSI level changes after this function is called.
* @since_tizen 3.0
* @param[in] wifi The Wi-Fi handle
* @return 0 on success, otherwise negative error value
/**
* @brief Registers a callback called when the Wi-Fi Module state is changed.
+ * @details This function registers a callback function to monitor changes in the Wi-Fi module state.
+ * When the state of the Wi-Fi module changes (e.g., enabled or disabled),
+ * the registered callback function will be invoked with the updated state and the provided user data.
* @since_tizen 4.0
* @param[in] wifi The Wi-Fi handle
* @param[in] callback The callback function to be called
/**
* @brief Unregisters the callback called when the Wi-Fi Module state is changed.
+ * @details This function removes the previously registered callback for monitoring changes in the Wi-Fi module state.
+ * The callback will no longer be invoked when the Wi-Fi module state changes after this function is called.
* @since_tizen 4.0
* @param[in] wifi The Wi-Fi handle
* @return @c 0 on success, otherwise negative error value
/**
* @brief Gets the Wi-Fi Module state.
+ * @details This function retrieves the current state of the Wi-Fi module.
+ * The Wi-Fi module state indicates whether the Wi-Fi hardware is enabled or disabled.
+ * This information is useful for determining if the device is capable of connecting to wireless networks.
* @since_tizen 4.0
* @param[in] wifi The Wi-Fi handle
* @param[out] state The Wi-Fi Module state
/**
* @brief Starts BSSID scan asynchronously.
+ * @details This function starts a BSSID (Basic Service Set Identifier) scan to discover wireless access points.
+ * A BSSID scan focuses on finding specific access points based on their MAC addresses rather than scanning for all available networks.
+ * The scan is performed asynchronously, and the result is reported through the provided callback function.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set \n
/**
* @brief Creates the access point handle.
+ * @details This function creates a new access point handle for a visible wireless network.
+ * The ESSID (Extended Service Set Identifier) should be provided as a null-terminated string and can be encoded in UTF-8.
+ * The created access point handle can be used to connect to the specified wireless network using the Wi-Fi handle.
* @since_tizen 3.0
* @remarks You must release @a ap using wifi_manager_ap_destroy().
* @param[in] wifi The Wi-Fi handle
/**
* @brief Creates the hidden access point handle.
+ * @details This function creates a new access point handle for a hidden wireless network.
+ * Hidden networks do not broadcast their SSID (Service Set Identifier),
+ * so you need to provide the ESSID (Extended Service Set Identifier) explicitly when creating the access point handle.
+ * The ESSID should be a null-terminated string and can be encoded in UTF-8.
* @since_tizen 3.0
* @remarks You must release @a ap using wifi_manager_ap_destroy().
* @param[in] wifi The Wi-Fi handle
/**
* @brief Destroys the access point handle.
+ * @details This function releases all resources allocated for the given access point handle.
+ * After calling this function, the access point handle becomes invalid and cannot be used for any further operations.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @return 0 on success, otherwise negative error value
/**
* @brief Clones the access point handle.
+ * @details This function creates a new access point handle that is a copy of the given access point handle.
+ * The cloned access point handle contains the same information as the original handle,
+ * allowing you to work with the same access point data without modifying the original handle.
* @since_tizen 3.0
* @remarks You must release @a cloned_ap using wifi_manager_ap_destroy().
* @param[out] cloned_ap The cloned access point handle
/**
* @brief Refreshes the access point information.
+ * @details This function refreshes the access point information.
+ * Access point information can change over time due to various factors such as changes in the environment,
+ * network configuration updates, or other network events.
+ * By calling this function, you ensure that the latest information about the access point is retrieved and stored in the given access point handle.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Gets ESSID (Extended Service Set Identifier).
+ * @details This function retrieves the Extended Service Set Identifier (ESSID) for the access point.
+ * The ESSID is a unique identifier assigned to a group of wireless access points that form an extended service set,
+ * typically represented as a sequence of characters (e.g., "MyHomeNetwork").
+ * In most cases, the ESSID is identical to the SSID of the primary access point within the extended service set.
* @since_tizen 3.0
* @remarks You must release @a essid using free().
* @param[in] ap The access point handle
/**
* @brief Gets raw SSID (Service Set Identifier).
+ * @details This function retrieves the raw Service Set Identifier (SSID) for the access point.
+ * The SSID is a unique identifier assigned to a wireless network, typically represented as a sequence of characters (e.g., "MyHomeNetwork").
+ * This function returns the raw SSID as a byte array, allowing direct access to the underlying data without any character encoding considerations.
* @since_tizen 4.0
* @remarks You must release @a ssid using free().
* @param[in] ap The access point handle
/**
* @brief Gets BSSID (Basic Service Set Identifier).
+ * @details This function retrieves the Basic Service Set Identifier (BSSID) for the access point.
+ * The BSSID is a unique identifier assigned to each wireless access point,
+ * consisting of a MAC address formatted as a string (e.g., "00:1A:2B:3C:4D:5E").
* @since_tizen 3.0
* @remarks You must release @a bssid using free().
* @param[in] ap The access point handle
/**
* @brief Gets the RSSI.
+ * @details This function retrieves the Received Signal Strength Indication (RSSI) value for the access point.
+ * The RSSI value indicates the strength of the received signal from the access point, measured in decibels relative to milliwatts (dBm).
+ * A higher RSSI value generally indicates a stronger signal and better connection quality.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] rssi The RSSI value (in dBm)
/**
* @brief Gets the RSSI level.
+ * @details This function retrieves the Received Signal Strength Indication (RSSI) level for the access point.
+ * The RSSI level indicates the strength of the received signal from the access point,
+ * which can be used to determine the quality of the wireless connection.
* @since_tizen 4.0
* @param[in] ap The access point handle
* @param[out] rssi_level The RSSI level
/**
* @brief Gets the frequency band (MHz).
+ * @details This function retrieves the frequency band (in megahertz, MHz) for the access point.
+ * The frequency band indicates the specific radio frequency range used by the access point to transmit and receive wireless signals.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] frequency The frequency
/**
* @brief Gets the max speed (Mbps).
+ * @details This function retrieves the maximum achievable speed (in megabits per second, Mbps) for the access point.
+ * The maximum speed indicates the highest possible data transfer rate that can be achieved when connected to the access point.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] max_speed The max speed
/**
* @brief Checks whether the access point is favorite or not.
+ * @details This function determines whether the access point is marked as a favorite or not.
+ * A favorite access point is one that the user has explicitly chosen to connect to frequently or has saved for future use.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] favorite @c true if access point is favorite,
/**
* @brief Checks whether the access point is passpoint or not.
+ * @details This function determines whether the access point is a Passpoint or not.
+ * A Passpoint access point is a type of Wi-Fi hotspot that supports the Hotspot 2.0 standard,
+ * providing seamless and secure connectivity across various networks.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] passpoint @c true if access point is passpoint,
/**
* @brief Checks whether the access point is hidden or not.
+ * @details This function determines whether the access point is hidden or not.
+ * A hidden access point does not broadcast its SSID (Service Set Identifier), making it less visible to potential clients.
* @since_tizen 5.5
* @param[in] ap The access point handle
* @param[out] is_hidden @c true if the access point is hidden,
/**
* @brief Gets the connection state.
+ * @details This function retrieves the current connection state of the access point.
+ * The connection state indicates whether the access point is currently connected, connecting, or disconnected.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] state The connection state
/**
* @brief Gets the config type of IP.
+ * @details This function retrieves the configuration type of the IP for the specified address family.
+ * The IP configuration type indicates whether the IP address is statically configured or dynamically assigned via DHCP.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Gets the IP address.
+ * @details This function retrieves the IP address for the specified address family.
+ * The IP address is the unique identifier assigned to a device on a network,
+ * allowing it to communicate with other devices on the same network or across different networks.
* @since_tizen 3.0
* @remarks You must release @a ip_address using free().
* @param[in] ap The access point handle
/**
* @brief Sets the IP address.
+ * @details This function sets the IP address for the specified address family.
+ * If the IP address is set to NULL, the existing IP address for that address family will be deleted.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Called with an IPv6 address.
+ * @details This callback function type is used by the `wifi_manager_ap_foreach_ipv6_address()` function
+ * to iterate over each IPv6 address assigned to the Wi-Fi interface for the specified access point.
+ * The callback function receives the IPv6 address as a parameter and returns a boolean value indicating whether to continue iterating or to stop.
* @since_tizen 4.0
* @remarks If @a ipv6_address is needed outside the callback, a copy should be
* made. @a ipv6_address will be freed automatically after the execution
/**
* @brief Gets all IPv6 addresses assigned to the Wi-Fi interface.
+ * @details This function retrieves all IPv6 addresses assigned to the Wi-Fi interface for the specified access point.
+ * It uses a callback function to iterate over each IPv6 address and provide it to the caller.
* @since_tizen 4.0
* @param[in] ap The access point handle
* @param[in] callback The callback to be called for each IPv6 address
/**
* @brief Gets the subnet mask.
+ * @details This function retrieves the subnet mask for the specified address family.
+ * The subnet mask is used to determine which part of an IP address represents the network portion and which part represents the host portion.
* @since_tizen 3.0
* @remarks You must release @a subnet_mask using free().
* @param[in] ap The access point handle
/**
* @brief Sets the subnet mask.
+ * @details This function sets the subnet mask for the specified address family.
+ * If the subnet mask is set to NULL, the existing subnet mask for that address family will be deleted.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Gets the gateway address.
+ * @details This function retrieves the gateway address for the specified address family.
+ * The gateway address is the IP address of the router or gateway that acts as the entry point to the wider internet or network.
* @since_tizen 3.0
* @remarks You must release @a gateway_address using free().
* @param[in] ap The access point handle
/**
* @brief Sets the gateway address.
+ * @details This function sets the gateway address for the specified address family.
+ * If the gateway address is set to NULL, the existing gateway address for that address family will be deleted.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Gets the DHCP Server address.
+ * @details This function retrieves the DHCP server address for the specified address family.
+ * The DHCP server address is the IP address of the server that provides dynamic IP addresses to devices on the network.
* @since_tizen 4.0
* @remarks You must release @a dhcp_server using g_free().
* This function is supported only for IPv4 address family.
/**
* @brief Gets the DHCP lease duration.
+ * @details This function retrieves the DHCP lease duration for the specified address family.
+ * The DHCP lease duration indicates the time period for which the IP address assigned to the device through DHCP will remain valid.
* @since_tizen 4.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Gets the proxy address.
+ * @details This function retrieves the proxy address for the specified address family.
+ * The retrieved proxy address can be used to configure the proxy settings for the network interface.
* @since_tizen 3.0
* @remarks You must release @a proxy_address using free().
* @param[in] ap The access point handle
/**
* @brief Sets the proxy address.
+ * @details This function sets the proxy address for the specified address family.
+ * If the proxy address is set to NULL, the existing proxy address for that address family will be deleted.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Gets the Proxy type.
+ * @details This function retrieves the proxy address type for the access point.
+ * The proxy type indicates whether the proxy settings are disabled, set to automatic, or set to manual.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] proxy_type The type of proxy
/**
* @brief Gets the DNS address.
+ * @details This function retrieves the DNS address for the specified order and address family.
+ * Up to two DNS addresses can be retrieved for each address family.
* @since_tizen 3.0
* @remarks The allowance of DNS address is @c 2.You must release @a dns_address using free().
* @param[in] ap The access point handle
/**
* @brief Sets the DNS address.
+ * @details This function sets the DNS address for the specified order and address family.
+ * Up to two DNS addresses can be set for each address family.
+ * If the DNS address is set to NULL, the existing DNS address for that order and address family will be deleted.
* @since_tizen 3.0
* @remarks The allowance of DNS address is @c 2 \n
* @param[in] ap The access point handle
/**
* @brief Gets the DNS config type.
+ * @details This function retrieves the DNS configuration type for the specified address family.
+ * The DNS configuration type indicates how the DNS server addresses are configured for the network interface.
* @since_tizen 4.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Sets the DNS config type.
+ * @details This function sets the DNS configuration type for the specified address family.
+ * The DNS configuration type determines how the DNS server addresses are configured for the network interface.
* @since_tizen 4.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Gets the network prefix length.
+ * @details This function retrieves the network prefix length for the specified address family.
+ * The network prefix length defines the subnet mask for the network interface,
+ * determining the range of IP addresses available for devices connected to the network.
* @since_tizen 4.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Sets the network prefix length.
+ * @details This function sets the network prefix length for the specified address family.
+ * The network prefix length is used to define the subnet mask for the network interface,
+ * which determines the range of IP addresses available for devices connected to the network.
* @since_tizen 4.0
* @param[in] ap The access point handle
* @param[in] address_family The address family
/**
* @brief Gets the Wi-Fi disconnect reason from the supplicant.
+ * @details This function retrieves the Wi-Fi disconnect reason from the supplicant.
+ * The disconnect reason provides detailed information about the cause of the disconnection between the device and the access point.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] disconnect_reason The supplicant disconnect reason
/**
* @brief Gets the error state.
+ * @details This function retrieves the Wi-Fi connection error state for the access point.
+ * The error state indicates any issues encountered during the connection process to the access point.
* @since_tizen 4.0
* @param[in] ap The access point handle
* @param[out] error_state The Wi-Fi connection error state
/**
* @brief Gets the Wi-Fi Association Status Code from the supplicant.
+ * @details This function retrieves the Wi-Fi Association Status Code from the supplicant.
+ * The status code provides detailed information about the result of the association process between the device and the access point.
* @since_tizen 5.0
* @param[in] ap The access point handle
* @param[out] status_code The supplicant Wi-Fi association status code
wifi_manager_assoc_status_code_e *status_code);
/**
* @brief Called with VSIE data and length of VSIE.
+ * @details This callback function type is used to iterate through the Vendor-Specific Information Element (VSIE) list.
+ * It is called once for each VSIE found, providing the VSIE data and its length.
* @since_tizen 5.0
* @remarks If @a vsie is needed outside the callback, a copy should be
* made. @a vsie will be freed automatically after the execution
/**
* @brief Gets all VSIE of AP.
+ * @details This function retrieves all Vendor-Specific Information Elements (VSIE) associated with the access point.
+ * VSIE are custom elements added by vendors to provide additional information about the access point.
* @since_tizen 5.0
* @param[in] ap The access point handle
* @param[in] callback The callback to be called for each VSIE of AP
/**
* @brief Gets the raw country code.
+ * @details This function retrieves the raw country code associated with the access point.
+ * The country code is a two-letter ISO 3166-1 alpha-2 country code that identifies the country where the access point is located.
* @since_tizen 5.0
* @remarks You must release @a country_code using free().
* @param[in] ap The access point handle
/**
* @brief Called for each found BSSID.
+ * @details This callback function type is used to iterate through the found BSSID list.
+ * It is called once for each BSSID found, providing information about the BSSID,
+ * its signal strength (RSSI), and its operating frequency.
* @since_tizen 5.0
* @remarks The @a bssid can be used only in the callback. To use it outside, make a copy.
* @a bssid is managed by the platform and will be released after the execution
/**
* @brief Gets the BSSID list.
+ * @details This function retrieves the BSSID list associated with the access point.
+ * Each BSSID represents a unique identifier for a wireless network interface,
+ * typically corresponding to a specific access point or router.
* @since_tizen 5.0
* @param[in] ap The access point handle
* @param[in] callback The callback to be called
/**
* @brief Gets the Wi-Fi security mode.
+ * @details This function retrieves the Wi-Fi security mode for the access point.
+ * The security mode determines the level of protection provided to the Wi-Fi network against unauthorized access and attacks.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] type The type of Wi-Fi security
/**
* @brief Sets the Wi-Fi security mode.
+ * @details This function sets the Wi-Fi security mode for the access point.
+ * The security mode determines the level of protection provided to the Wi-Fi network against unauthorized access and attacks.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] type The type of Wi-Fi security
/**
* @brief Gets the Wi-Fi encryption type.
+ * @details This function retrieves the Wi-Fi encryption type for the access point.
+ * The encryption type determines how data transmitted over the Wi-Fi network is protected from unauthorized access.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] type The type of Wi-Fi encryption
/**
* @brief Sets the Wi-Fi encryption type.
+ * @details This function sets the Wi-Fi encryption type for the access point.
+ * The encryption type determines how data transmitted over the Wi-Fi network is protected from unauthorized access.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] type The type of Wi-Fi encryption
/**
* @brief Checks whether the passphrase is required or not.
+ * @details This function checks whether a passphrase is required for the access point.
+ * A passphrase is necessary to authenticate and establish a secure connection with the access point.
* @since_tizen 3.0
* @remarks This function is not valid if security type is #WIFI_MANAGER_SECURITY_TYPE_EAP.
* @param[in] ap The access point handle
int wifi_manager_ap_is_passphrase_required(wifi_manager_ap_h ap, bool *required);
/**
- * @brief Sets the passphrase.
+ * @brief sets the passphrase for a Wi-Fi access point
+ * @details This function sets the passphrase for a Wi-Fi access point.
+ * The passphrase is used to authenticate and establish a secure connection with the access point.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] passphrase The passphrase of access point
/**
* @brief Checks whether the WPS(Wi-Fi Protected Setup) is supported or not.
+ * @details This function checks whether WPS is supported by the access point.
+ * WPS is a standard that simplifies the process of setting up secure Wi-Fi connections
+ * by allowing devices to connect to each other without entering passwords manually.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] supported @c true if WPS is supported,
/**
* @brief Checks whether Protected Management Frame is required.
+ * @details This function checks whether PMF is required for the access point.
+ * PMF is a security feature that protects wireless networks from various types of attacks,
+ * such as deauthentication and disassociation attacks.
* @since_tizen 7.0
* @param[in] ap The access point handle
* @param[out] required true when required and false when not required
/**
* @brief Gets the passphrase of EAP.
+ * @details This function retrieves the user name and password status used for EAP authentication.
+ * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_PEAP or #WIFI_MANAGER_EAP_TYPE_TTLS.
* @since_tizen 3.0
* @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_PEAP or #WIFI_MANAGER_EAP_TYPE_TTLS.
* You must release @a user_name using free().
/**
* @brief Sets access point anonymous identity.
+ * @details This function sets the anonymous identity for EAP authentication.
+ * The anonymous identity is an optional field that can be used to provide additional information about the client during the EAP authentication process.
* @since_tizen 5.5
* @param[in] ap The access point handle
* @param[in] anonymous_identity The anonymous identity
/**
* @brief Gets access point anonymous identity.
+ * @details This function retrieves the anonymous identity used for EAP authentication.
+ * The anonymous identity is an optional field that can be used to provide additional information about the client during the EAP authentication process.
* @since_tizen 5.5
* @remarks You must release @a anonymous_identity using free().
* @param[in] ap The access point handle
/**
* @brief Gets the CA Certificate of EAP.
+ * @details This function retrieves the file path of the CA certificate used for EAP authentication.
+ * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS.
* @since_tizen 3.0
* @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS.
* You must release @a file using free().
/**
* @brief Sets the CA Certificate of EAP.
+ * @details This function sets the CA certificate for EAP authentication.
+ * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS.
+ * The CA certificate is used to verify the server's identity during the EAP authentication process.
* @since_tizen 3.0
* @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS.
* @param[in] ap The access point handle
/**
* @brief Gets the Client Certificate of EAP.
+ * @details This function retrieves the file path of the client certificate used for EAP authentication.
+ * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS.
* @since_tizen 3.0
* @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS.
* You must release @a file using free().
/**
* @brief Sets the Client Certificate of EAP.
+ * @details This function sets the client certificate for EAP authentication.
+ * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS.
+ * The client certificate is used to verify the client's identity during the EAP authentication process.
* @since_tizen 3.0
* @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS.
* @param[in] ap The access point handle
/**
* @brief Gets the private key file of EAP.
+ * @details This function retrieves the file path of the private key used for EAP authentication.
+ * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS.
* @since_tizen 3.0
* @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS.
* You must release @a file using free().
/**
* @brief Sets the private key information of EAP.
+ * @details This function sets the private key information for EAP authentication.
+ * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS.
+ * The private key information includes the file path of the private key and its corresponding password.
* @since_tizen 3.0
* @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS.
* @param[in] ap The access point handle
/**
* @brief Gets the EAP type of Wi-Fi.
+ * @details This function retrieves the EAP type set for the given Wi-Fi access point.
+ * The EAP type specifies the EAP method that should be used during the EAP authentication process.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] type The type of EAP
/**
* @brief Sets the EAP type of Wi-Fi.
+ * @details This function sets the EAP type for the given Wi-Fi access point.
+ * The EAP type specifies the EAP method that should be used during the EAP authentication process.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] type The type of EAP
/**
* @brief Gets the type of EAP phase2 authentication of Wi-Fi.
+ * @details This function retrieves the EAP Phase 2 authentication type set for the given Wi-Fi access point.
+ * The EAP Phase 2 authentication type specifies how the client should authenticate itself during the second phase of the EAP authentication process.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[out] type The type of EAP phase2 authentication
/**
* @brief Sets the type of EAP phase2 authentication of Wi-Fi.
+ * @details This function sets the EAP Phase 2 authentication type for the given Wi-Fi access point.
+ * The EAP Phase 2 authentication type specifies how the client should authenticate itself during the second phase of the EAP authentication process.
* @since_tizen 3.0
* @param[in] ap The access point handle
* @param[in] type The type of EAP phase2 authentication
/**
* @brief Gets access point configuration handle.
+ * @details This function creates a new access point configuration handle with the provided parameters.
+ * The handle can be used to save or update the access point configuration.
* @since_tizen 3.0
* @remarks You must release @a config using wifi_manager_config_destroy().
*
/**
* @brief Clones the access point configuration handle.
+ * @details This function creates a copy of the given access point configuration handle.
+ * The new handle has the same properties as the original handle.
* @since_tizen 3.0
* @remarks You must release @a cloned_config using wifi_manager_config_destroy().
*
/**
* @brief Destroys the access point configuration handle.
+ * @details This function destroys the access point configuration handle and releases all its associated resources.
+ * After calling this function, the handle is no longer valid.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Removes Wi-Fi configuration of access point.
+ * @details This function deletes the specified access point configuration from the system.
+ * After this function is called, the access point configuration will no longer be available.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile
/**
* @brief Gets configurations of an access point.
+ * @details This function retrieves all access point configurations stored in the system.
+ * Each access point configuration is represented by a handle,
+ * which can be used to get detailed information about the access point.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.profile
/**
* @brief Gets the name of access point from configuration.
+ * @details This function retrieves the name set for the given access point configuration.
+ * The name is a user-friendly identifier for the access point.
* @since_tizen 3.0
* @remarks You must release @a name using free().
*
/**
* @brief Gets the security type of access point from configuration.
+ * @details This function retrieves the security type set for the given access point configuration.
+ * The security type determines the type of security mechanism used to protect the wireless network.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Sets access point proxy address configuration.
+ * @details This function sets the proxy address for the given access point configuration.
+ * The proxy address is used to route traffic through a proxy server.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets the proxy address of access point from configuration.
+ * @details This function retrieves the proxy address set for the given access point configuration.
+ * The proxy address is used to route traffic through a proxy server.
* @since_tizen 3.0
* @remarks You must release @a proxy_address using free().
*
/**
* @brief Sets the hidden property of access point from the configuration.
+ * @details This function sets the hidden property of the access point in the given access point configuration.
+ * The hidden property indicates whether the access point is hidden or not.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets the hidden property of access point from the configuration.
+ * @details This function retrieves the hidden property of the access point set in the given access point configuration.
+ * The hidden property indicates whether the access point is hidden or not.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point IP config type from configuration.
+ * @details This function retrieves the IP configuration type set for the given access point configuration.
+ * The IP configuration type determines how the IP address and related information (e.g., subnet mask, gateway) are obtained.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Sets access point IP config type to configuration.
+ * @details This function sets the IP configuration type for the given access point configuration.
+ * The IP configuration type determines how the IP address and related information (e.g., subnet mask, gateway) are obtained.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point IP address from configuration.
+ * @details This function retrieves the IP address set for the given access point configuration.
+ * The IP address is used as the local address for the device when connected to the access point.
* @since_tizen 5.0
* @remarks You must release @a ip_address using free().
*
/**
* @brief Sets access point IP address to configuration.
+ * @details This function sets the IP address for the given access point configuration.
+ * The IP address is used as the local address for the device when connected to the access point.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point subnet mask from configuration.
+ * @details This function retrieves the subnet mask set for the given access point configuration.
+ * The subnet mask is used to specify the network portion of an IP address.
* @since_tizen 5.0
* @remarks You must release @a subnet_mask using free().
*
/**
* @brief Sets access point subnet mask to configuration.
+ * @details This function sets the subnet mask for the given access point configuration.
+ * The subnet mask is used to specify the network portion of an IP address.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets the network prefix length from configuration.
+ * @details This function retrieves the network prefix length set for the given access point configuration.
+ * The network prefix length specifies the number of leading bits in the IP address that are used to determine the network portion of the address.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Sets the network prefix length to configuration.
+ * @details This function sets the network prefix length for the given access point configuration.
+ * The network prefix length specifies the number of leading bits in the IP address that are used to determine the network portion of the address.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point gateway address from configuration.
+ * @details This function retrieves the gateway address set for the given access point configuration.
+ * The gateway address is used as the default route for the network traffic.
* @since_tizen 5.0
* @remarks You must release @a gateway_address using free().
*
/**
* @brief Sets access point gateway address to configuration.
+ * @details This function sets the gateway address for the given access point configuration.
+ * The gateway address is used as the default route for the network traffic.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point dns config type from configuration.
+ * @details This function retrieves the DNS configuration type set for the given access point configuration.
+ * The DNS configuration type specifies how the DNS addresses are configured for the access point.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Sets access point dns config type to configuration.
+ * @details This function sets the DNS configuration type for the given access point configuration.
+ * The DNS configuration type specifies how the DNS addresses are configured for the access point.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point dns address from configuration.
+ * @details This function retrieves the DNS address set for the given access point configuration.
+ * The DNS address is used to resolve domain names to IP addresses during the network communication process.
* @since_tizen 5.0
* @remarks The allowance of DNS address is @c 2.You must release @a dns_address using free().
*
/**
* @brief Sets access point dns address to configuration.
+ * @details This function sets the DNS address for the given access point configuration.
+ * The DNS address is used to resolve domain names to IP addresses during the network communication process.
* @since_tizen 5.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point anonymous identity from configuration.
+ * @details This function retrieves the anonymous identity set for the given access point configuration.
+ * The anonymous identity is used during the authentication process to identify the client anonymously when connecting to the access point.
* @since_tizen 3.0
* @remarks You must release @a anonymous_identity using free().
*
/**
* @brief Sets access point anonymous identity to configuration.
+ * @details This function sets the anonymous identity for the given access point configuration.
+ * The anonymous identity is used during the authentication process to identify the client anonymously when connecting to the access point.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point cacert file from configuration.
+ * @details This function retrieves the CA certificate file path set for the given access point configuration.
+ * The CA certificate file contains the trusted root certificates used to verify the server's certificate during the authentication process.
* @since_tizen 3.0
* @remarks You must release @a ca_cert using free().
* @remarks The mediastorage privilege %http://tizen.org/privilege/mediastorage is needed \n
/**
* @brief Sets access point cacert file to configuration.
+ * @details This function sets the CA certificate file required for EAP authentication.
+ * The CA certificate file contains the trusted root certificates used to verify the server's certificate during the authentication process.
* @since_tizen 3.0
* @remarks The mediastorage privilege %http://tizen.org/privilege/mediastorage is needed \n
* if @a ca_cert is relevant to media storage.\n
/**
* @brief Gets access point client cert file from configuration.
+ * @details This function retrieves the client certificate file path set for the given access point configuration.
+ * The client certificate file is used for EAP authentication to establish a secure connection with the access point.
* @since_tizen 3.0
* @remarks You must release @a client_cert using free().
*
/**
* @brief Sets access point client cert file to configuration.
+ * @details This function sets the client certificate and private key files required for EAP authentication.
+ * These files are used to establish a secure connection with the access point.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets the private key file of EAP.
+ * @details This function retrieves the file path of the private key used for EAP-TLS authentication.
+ * This function is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS.
* @since_tizen 5.0
* @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS.
* You must release @a file using free().
/**
* @brief Sets the private key information of EAP.
+ * @details This function sets the private key information required for EAP-TLS authentication.
+ * It includes the file path of the private key and its corresponding password.
+ * This function is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS.
* @since_tizen 5.0
* @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS.
*
/**
* @brief Gets access point identity from configuration.
+ * @details This function retrieves the EAP identity set for the given access point configuration.
+ * The EAP identity is used during the authentication process to identify the client when connecting to the access point.
* @since_tizen 3.0
* @remarks You must release @a identity using free().
*
/**
* @brief Sets access point identity to configuration.
+ * @details This function sets the EAP identity for the given access point configuration.
+ * The EAP identity is used during the authentication process to identify the client when connecting to the access point.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point EAP type from configuration.
+ * @details This function retrieves the EAP type set for the given access point configuration.
+ * The EAP type specifies the EAP protocol used to authenticate the client when connecting to the access point.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Sets access point EAP type to configuration.
+ * @details This function sets the EAP type for the given access point configuration.
+ * The EAP type specifies the EAP protocol used to authenticate the client when connecting to the access point.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point EAP auth type from configuration.
+ * @details This function retrieves the EAP authentication type set for the given access point configuration.
+ * The EAP authentication type specifies the method used to authenticate the client when connecting to the access point.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Sets access point EAP auth type to configuration.
+ * @details This function sets the EAP authentication type for the given access point configuration.
+ * The EAP authentication type specifies the method used to authenticate the client when connecting to the access point.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Gets access point subject match from configuration.
+ * @details This function retrieves the EAP subject match set for the given access point configuration.
+ * The EAP subject match specifies which certificates to trust when connecting to the access point.
* @since_tizen 3.0
* @remarks You must release @a subject_match using free().
*
/**
* @brief Sets access point subject match to configuration.
+ * @details This function sets the EAP subject match for the given access point configuration.
+ * The EAP subject match is used to specify which certificates to trust when connecting to the access point.
* @since_tizen 3.0
*
* @param[in] config The access point configuration handle
/**
* @brief Registers the callback called when a TDLS device is found.
+ * @details This function registers a callback function to receive notifications about discovered TDLS (802.11z) devices.
+ * When a TDLS device is found, the provided callback function will be called with the device information as an argument.
* @since_tizen 4.0
*
* @param[in] wifi The Wi-Fi handle
/**
* @brief Unregisters the callback called when TDLS device is found.
+ * @details This function unregisters the callback that was previously registered using wifi_manager_tdls_set_discovered_cb().
+ * After calling this function, the application will no longer receive notifications about discovered TDLS devices.
* @since_tizen 4.0
*
* @param[in] wifi The Wi-Fi handle
/**
* @brief Discovers devices that support TDLS.
+ * @details This function initiates a discovery process to find TDLS (802.11z)-capable devices within range.
+ * The MAC address of the peer device to be discovered can be optionally provided as an argument.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
/**
* @brief Connects to a peer device.
+ * @details This function establishes a TDLS (802.11z) connection with the specified peer device.
+ * The MAC address of the peer device to be connected must be provided as an argument.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
/**
* @brief Disconnects the connected peer.
+ * @details This function disconnects the currently connected TDLS (802.11z) peer.
+ * The MAC address of the peer to be disconnected must be provided as an argument.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
/**
* @brief Gets Peer Mac address of Connected peer.
+ * @details This function retrieves the MAC address of the currently connected TDLS (802.11z) peer.
+ * The MAC address is returned as a null-terminated string and must be freed by the caller after use
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Registers the callback called when TDLS state is changed.
+ * @details This function registers a callback function to receive notifications about changes in the TDLS (802.11z) state.
+ * When the TDLS state changes, the provided callback function will be called with the new state as an argument.
* @since_tizen 3.0
*
* @param[in] wifi The Wi-Fi handle
/**
* @brief Unregisters the callback called when TDLS state is changed.
+ * @details This function unregisters the callback that was previously registered using wifi_manager_tdls_set_state_changed_cb().
+ * After calling this function, the application will no longer receive notifications about changes in the TDLS state.
* @since_tizen 3.0
*
* @param[in] wifi The Wi-Fi handle
/**
* @brief Enables a TDLS channel switching request.
+ * @details This function enables the TDLS (802.11z) channel switching request for the specified TDLS peer.
+ * Channel switching allows the two peers to switch to a different channel to improve communication performance.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
/**
* @brief Disables a TDLS channel switching request.
+ * @details This function disables the TDLS (802.11z) channel switching request for the specified TDLS peer.
+ * Channel switching allows the two peers to switch to a different channel to improve communication performance.
* @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
/**
* @brief Registers the callback called when IP conflict state is changed.
+ * @details This function registers a callback function to receive notifications about changes in the IP conflict state.
+ * When the IP conflict state changes, the provided callback function will be called with the new state as an argument.
* @since_tizen 5.0
* @param[in] wifi The Wi-Fi handle
* @param[in] callback The callback function to be called
/**
* @brief Unregisters the callback called when IP conflict state is changed.
+ * @details This function unregisters the callback that was previously registered using wifi_manager_set_ip_conflict_cb().
+ * After calling this function, the application will no longer receive notifications about changes in the IP conflict state.
* @since_tizen 5.0
* @param[in] wifi The Wi-Fi handle
* @return 0 on success, otherwise negative error value
/**
* @brief Enables or disables IP conflict detection.
+ * @details This function enables or disables the IP conflict detection feature on the device. When enabled,
+ * the device periodically checks for IP address conflicts with other devices on the same network.
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.set
/**
* @brief Checks whether IP conflict detection is enabled.
+ * @details This function checks if the IP conflict detection feature is enabled on the device.
+ * If the feature is enabled, the function sets the @a state parameter to @c true;
+ * otherwise, it sets it to @c false.
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Gets the state of the IP conflict.
+ * @details This function retrieves the current state of the IP conflict detection feature.
+ * The IP conflict state indicates whether there is an IP address conflict
+ * with other devices on the same network.
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Gets whether 5Ghz Wi-Fi band is supported.
+ * @details This function checks if the device supports the 5Ghz Wi-Fi band.
+ * If the device supports it, the function sets the @a supported parameter to @c true;
+ * otherwise, it sets it to @c false.
* @since_tizen 5.5
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
/**
* @brief Gets whether 6Ghz Wi-Fi band is supported.
+ * @details This function checks if the device supports the 6Ghz Wi-Fi band.
+ * If the device supports it, the function sets the @a supported parameter to @c true;
+ * otherwise, it sets it to @c false.
* @since_tizen 8.0
* @privlevel public
* @privilege %http://tizen.org/privilege/network.get
projects / platform / core / api / wifi-manager.git / commitdiff