diff options
author | Abhay Agarwal <ay.agarwal@samsung.com> | 2021-02-02 11:34:15 +0530 |
---|---|---|
committer | Abhay Agarwal <ay.agarwal@samsung.com> | 2021-02-03 09:17:31 +0530 |
commit | 1c086f8d27381b03ef1cf0bbf4c7322e691a9d65 (patch) | |
tree | 14addc0a14fbd5f1038b9c7b455a9820469d640c | |
parent | 681575e9da321e9c6be4a4c093ad5915b8f8d7f3 (diff) | |
download | user-awareness-1c086f8d27381b03ef1cf0bbf4c7322e691a9d65.tar.gz user-awareness-1c086f8d27381b03ef1cf0bbf4c7322e691a9d65.tar.bz2 user-awareness-1c086f8d27381b03ef1cf0bbf4c7322e691a9d65.zip |
Add privilege for public API functions
Change-Id: I2b2486ce460f0d00d9d49311940b01fc3337886b
Signed-off-by: Abhay Agarwal <ay.agarwal@samsung.com>
-rwxr-xr-x | include/user-awareness.h | 82 |
1 files changed, 80 insertions, 2 deletions
diff --git a/include/user-awareness.h b/include/user-awareness.h index bee3e0f..659a57d 100755 --- a/include/user-awareness.h +++ b/include/user-awareness.h @@ -101,6 +101,8 @@ int ua_foreach_services( * @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 handle should be destroyed by using #ua_monitor_destroy(). * @@ -108,6 +110,7 @@ int ua_foreach_services( * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OUT_OF_MEMORY Out of memory * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -125,11 +128,14 @@ 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] handle The monitor handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet * @@ -146,12 +152,15 @@ int ua_monitor_destroy( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Adds sensors to UA monitor for which monitoring is to be done. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] handle The monitor handle * @param[in] sensor The sensor to be added to monitor * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_PERMITTED Operation not permitted * @retval #UA_ERROR_ALREADY_DONE Already done @@ -174,12 +183,15 @@ 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 * * @param[in] handle The monitor handle * @param[in] sensor Sensor to be removed from monitor * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_PERMITTED Operation not permitted * @retval #UA_ERROR_ALREADY_DONE Already done @@ -299,6 +311,8 @@ int ua_monitor_unset_sensor_status_cb( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Starts scan of registered devices. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @remarks Only one scan can run at one time. * @@ -311,6 +325,7 @@ int ua_monitor_unset_sensor_status_cb( * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOW_IN_PROGRESS Operation now in progress * @retval #UA_ERROR_NO_DATA No sensor available @@ -335,11 +350,14 @@ int ua_monitor_start_scan( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Stops ua_monitor_start_scan(). * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] monitor UA monitor's handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress * @retval #UA_ERROR_OPERATION_FAILED Operation failed @@ -358,6 +376,8 @@ int ua_monitor_stop_scan(ua_monitor_h monitor); * @ingroup CAPI_NETWORK_UA_MODULE * @brief Starts user presence detection. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @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. @@ -374,6 +394,7 @@ int ua_monitor_stop_scan(ua_monitor_h monitor); * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOW_IN_PROGRESS Operation now in progress * @retval #UA_ERROR_NO_DATA No sensor available @@ -398,11 +419,14 @@ int ua_monitor_start_presence_detection( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Stops user presence detection. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] monitor UA monitor's handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress * @retval #UA_ERROR_OPERATION_FAILED Operation failed @@ -421,6 +445,8 @@ int ua_monitor_stop_presence_detection( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Starts user absence detection. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @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. @@ -437,6 +463,7 @@ int ua_monitor_stop_presence_detection( * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOW_IN_PROGRESS Operation now in progress * @retval #UA_ERROR_NO_DATA No sensor available @@ -461,11 +488,14 @@ int ua_monitor_start_absence_detection( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Stops user absence detection. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] handle The monitor handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress * @retval #UA_ERROR_OPERATION_FAILED Operation failed @@ -484,6 +514,8 @@ 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(). * @@ -492,6 +524,7 @@ int ua_monitor_stop_absence_detection( * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OUT_OF_MEMORY Out of memory * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -509,6 +542,8 @@ 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. * @@ -516,6 +551,7 @@ int ua_user_create(const char *account, * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet * @@ -532,11 +568,14 @@ int ua_user_destroy( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Adds the user. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] user_handle The user handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OPERATION_FAILED Operation failed * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -553,11 +592,14 @@ int ua_user_add(ua_user_h user_handle); * @ingroup CAPI_NETWORK_UA_MODULE * @brief Removes the user. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] user_handle The user handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OPERATION_FAILED Operation failed * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -597,6 +639,8 @@ int ua_user_get_account(ua_user_h user_handle, char **account); * @ingroup CAPI_NETWORK_UA_MODULE * @brief Adds device for a user. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] user_handle The user handle. * @param[in] device_handle The device handle. @@ -605,6 +649,7 @@ int ua_user_get_account(ua_user_h user_handle, char **account); * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet * @@ -625,14 +670,17 @@ 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 * * @param[in] user_handle The user handle. * @param[in] device_handle The device handle. * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful - * @retcal #UA_ERROR_RESOURCE_BUSY Remove done. but another service uses thie device. + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter + * @retcal #UA_ERROR_RESOURCE_BUSY Remove done. but another service uses this device. * @retval #UA_ERROR_OPERATION_FAILED Operation failed * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet * @@ -676,6 +724,8 @@ 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(). * @@ -684,6 +734,7 @@ int ua_user_foreach_devices( * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OUT_OF_MEMORY Out of memory * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -702,6 +753,8 @@ 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 removed and all allocated memory (if any) will be released. * @@ -709,6 +762,7 @@ int ua_service_create( * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet * @@ -725,11 +779,14 @@ int ua_service_destroy( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Adds the service. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] service_handle The service handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OPERATION_FAILED Operation failed * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -747,11 +804,14 @@ int ua_service_add( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Updates the service. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] service_handle The service handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OPERATION_FAILED Operation failed * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -770,11 +830,14 @@ 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_handle The service handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OPERATION_FAILED Operation failed * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -940,12 +1003,15 @@ int ua_service_get_user_by_account(ua_service_h service_handle, * @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_handle The service handle. * @param[in] user_handle The user handle. * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet * @@ -963,12 +1029,15 @@ 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_handle The service handle. * @param[in] user_handle The user handle. * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OPERATION_FAILED Operation failed * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -1064,6 +1133,8 @@ 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 by using #ua_user_destroy(). * @@ -1075,6 +1146,7 @@ int ua_service_foreach_users( * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OUT_OF_MEMORY Out of memory * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet @@ -1094,6 +1166,8 @@ 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 removed and all allocated memory (if any) will be released. * @@ -1101,6 +1175,7 @@ int ua_device_create(ua_mac_type_e mac_type, * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet * @@ -1230,11 +1305,11 @@ int ua_device_get_device_id( * * @param[in] device_handle The device handle * @param[in] bssid The device's Wi-Fi BSSID. - * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet * * @exception * @pre @@ -1364,11 +1439,14 @@ int ua_device_get_pairing_required( * @ingroup CAPI_NETWORK_UA_MODULE * @brief Updates the device. * @since_tizen 6.5 + * @privlevel public + * @privilege %http://tizen.org/privilege/userawareness * * @param[in] device_handle The device handle * * @return 0 on success, otherwise a negative error value * @retval #UA_ERROR_NONE Successful + * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #UA_ERROR_OPERATION_FAILED Operation failed * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet |