Modify privilege info in header 80/254680/3
authorhyunuk.tak <hyunuk.tak@samsung.com>
Mon, 8 Mar 2021 07:44:08 +0000 (16:44 +0900)
committerhyunuk.tak <hyunuk.tak@samsung.com>
Tue, 9 Mar 2021 07:27:19 +0000 (16:27 +0900)
Change-Id: Ie71d17be0a4e1194c6c6d7eb09b8a06dd19a84eb
Signed-off-by: hyunuk.tak <hyunuk.tak@samsung.com>
include/user-awareness.h

index 9c7d05f843693c776612b0015b9016e08977f062..4f7ffc507c53ce7d56d1a883a7a5f7943c7fc377 100755 (executable)
@@ -132,8 +132,6 @@ int ua_get_service_by_name(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Creates the ua monitor's handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @remarks The @a monitor handle should be destroyed by using #ua_monitor_destroy().
  *
@@ -155,8 +153,6 @@ int ua_monitor_create(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Destroys the ua monitor's handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] monitor The monitor handle
  *
@@ -176,8 +172,10 @@ int ua_monitor_destroy(
  * @brief Adds sensors to UA monitor for which monitoring is to be done.
  * Availability of sensors to be added can be checked using #ua_monitor_is_sensor_available()
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @remarks If you want to add the BLE sensor,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to add the Wi-Fi sensor,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @param[in] monitor The monitor handle
  * @param[in] sensor The sensor to be added to monitor
@@ -203,8 +201,10 @@ int ua_monitor_add_sensor(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Removes sensors from UA monitor.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @remarks If you want to remove the BLE sensor,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to remove the Wi-Fi sensor,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @param[in] monitor The monitor handle
  * @param[in] sensor Sensor to be removed from monitor
@@ -315,7 +315,11 @@ int ua_monitor_unset_sensor_status_cb(
  * @brief Starts scan of registered devices.
  * @since_tizen 6.5
  * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @privilege %http://tizen.org/privilege/location
+ * @remarks If you want to start BLE scan,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to start Wi-Fi scan,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @remarks Only one scan can run at one time.
  *
@@ -350,7 +354,11 @@ int ua_monitor_start_scan(
  * @brief Stops ua_monitor_start_scan().
  * @since_tizen 6.5
  * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @privilege %http://tizen.org/privilege/location
+ * @remarks If you want to stop BLE scan,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to stop Wi-Fi scan,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @param[in] monitor UA monitor's handle
  *
@@ -371,7 +379,11 @@ int ua_monitor_stop_scan(ua_monitor_h monitor);
  * @brief Starts user presence detection.
  * @since_tizen 6.5
  * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @privilege %http://tizen.org/privilege/location
+ * @remarks If you want to start BLE presence detection,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to start Wi-Fi presence detection,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @remarks This function is not specific for any particular user's presence detection.
  * Therefore, the callback will be invoked when any user is detected by sensors.
@@ -410,7 +422,11 @@ int ua_monitor_start_presence_detection(
  * @brief Stops user presence detection.
  * @since_tizen 6.5
  * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @privilege %http://tizen.org/privilege/location
+ * @remarks If you want to stop BLE presence detection,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to stop Wi-Fi presence detection,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @param[in] monitor UA monitor's handle
  *
@@ -432,7 +448,11 @@ int ua_monitor_stop_presence_detection(
  * @brief Starts user absence detection.
  * @since_tizen 6.5
  * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @privilege %http://tizen.org/privilege/location
+ * @remarks If you want to start BLE absence detection,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to start Wi-Fi absence detection,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @remarks This function is not specific for any particular user's absence detection.
  * Therefore, the callback will be invoked only when no user is detected by sensors.
@@ -471,7 +491,11 @@ int ua_monitor_start_absence_detection(
  * @brief Stops user absence detection.
  * @since_tizen 6.5
  * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @privilege %http://tizen.org/privilege/location
+ * @remarks If you want to stop BLE absence detection,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to stop Wi-Fi absence detection,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @param[in] monitor The monitor handle
  *
@@ -492,8 +516,6 @@ int ua_monitor_stop_absence_detection(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Creates the user handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @remarks The @a user handle should be destroyed by using #ua_user_destroy().
  *
@@ -517,8 +539,6 @@ int ua_user_create(const char *account,
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Destroys the user handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @remarks User context will removed and all allocated memory (if any) will be released.
  *
@@ -540,8 +560,6 @@ int ua_user_destroy(
  * @brief Adds the user. Added user is stored in the database
  * and is also available after the application restarts.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] user The user handle
  *
@@ -561,8 +579,6 @@ int ua_user_add(ua_user_h user);
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Removes the user.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] user The user handle
  *
@@ -601,8 +617,10 @@ int ua_user_get_account(ua_user_h user, char **account);
  * @brief Adds device for a user. This information is stored in database
  * and is also available after the application restarts.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @remarks If you want to add the BLE device,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to add the Wi-Fi device,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @param[in] user The user handle.
  * @param[in] device The device handle.
@@ -628,8 +646,10 @@ int ua_user_add_device(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Removes the device handle for a user handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @remarks If you want to remove the BLE device,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to remove the Wi-Fi device,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @param[in] user The user handle.
  * @param[in] device The device handle.
@@ -674,8 +694,6 @@ int ua_user_foreach_devices(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Creates the service handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @remarks The @a service handle should be destroyed by using #ua_service_destroy().
  *
@@ -699,8 +717,6 @@ int ua_service_create(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Destroys the service handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @remarks Service context will be removed and all allocated memory (if any) will be released.
  *
@@ -722,8 +738,6 @@ int ua_service_destroy(
  * @brief Adds the service. Added service is stored in database
  * and is also available after the application restarts.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] service The service handle
  *
@@ -745,8 +759,6 @@ int ua_service_add(
  * To update a property of a service its respective setter functions
  * should be called and then followed by the call of ua_service_update().
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] service The service handle
  *
@@ -767,8 +779,6 @@ int ua_service_update(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Removes the service.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] service The service handle
  *
@@ -831,8 +841,6 @@ int ua_service_set_detection_threshold(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Gets detection threshold for service handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] service The service handle
  * @param[out] presence_threshold The service presence threshold information (in lux)
@@ -878,8 +886,6 @@ int ua_service_get_user_by_account(ua_service_h service,
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Adds a user for a specific service.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] service The service handle.
  * @param[in] user The user handle.
@@ -900,8 +906,6 @@ int ua_service_add_user(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Removes the user for the specific service handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] service The service handle.
  * @param[in] user The user handle.
@@ -923,8 +927,6 @@ int ua_service_remove_user(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Sets device discriminant for a specific service.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] service The service handle.
  * @param[in] device The device handle.
@@ -991,8 +993,6 @@ int ua_service_foreach_users(
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Creates the device handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @remarks The @a device handle should be destroyed using #ua_user_destroy().
  *
@@ -1020,8 +1020,6 @@ int ua_device_create(ua_mac_type_e mac_type,
  * @ingroup CAPI_NETWORK_UA_MODULE
  * @brief Destroys the device handle.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @remarks Device context will be removed and all allocated memory (if any) will be released.
  *
@@ -1062,8 +1060,6 @@ int ua_device_get_mac_type(
  * If the device has already been added, this call should be followed by
  * the call of ua_device_update() to reflect the modifications.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] device The device handle
  * @param[in] os The device's operating system.
@@ -1143,8 +1139,6 @@ int ua_device_get_device_id(
  * If the device has already been added, this call should be followed by
  * the call of ua_device_update() to reflect the modifications.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] device The device handle
  * @param[in] bssid  The device's Wi-Fi BSSID.
@@ -1185,8 +1179,6 @@ int ua_device_get_wifi_bssid(
  * If the device has already been added, this call should be followed by
  * the call of ua_device_update() to reflect the modifications.
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
  *
  * @param[in] device The device handle
  * @param[in] ipv4_address The device's wifi IPv4 address.
@@ -1266,8 +1258,10 @@ int ua_device_get_pairing_required(
  * To update a property of a device its respective setter functions
  * should be called and then followed by the call of ua_device_update().
  * @since_tizen 6.5
- * @privlevel public
- * @privilege %http://tizen.org/privilege/userawareness
+ * @remarks If you want to update BLE device,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * if you want to update Wi-Fi device,
+ * you should add privilege %http://tizen.org/privilege/network.get.
  *
  * @param[in] device The device handle
  *