From: saerome.kim Date: Fri, 30 Mar 2018 04:08:45 +0000 (+0900) Subject: capi: add privilege comments X-Git-Tag: submit/tizen/20190131.065036~69 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ef0e9e5a444f35e29f3c40d2620fa6d1c683be60;p=platform%2Fcore%2Fapi%2Fmulti-device-group.git capi: add privilege comments Signed-off-by: saerome.kim --- diff --git a/capi/include/companion.h b/capi/include/companion.h index c813996..679515a 100644 --- a/capi/include/companion.h +++ b/capi/include/companion.h @@ -101,6 +101,8 @@ typedef void *companion_device_h; /**< Device handle */ * @details This function can receive a group resource found. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @remarks The @a group should not be released. * @remarks The @a group can be used only in the callback. To use outside, make a copy. @@ -121,6 +123,8 @@ typedef bool (*companion_group_found_cb)(companion_group_type_e type, * @details This function can receive a device found. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @remarks The @a device should not be released. * @remarks The @a device can be used only in the callback. To use outside, make a copy. @@ -139,6 +143,8 @@ typedef bool (*companion_device_found_cb)(companion_device_h device, void *user_ * @details Called when the maximum wait time elapsed after the companion_group_find() done. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[out] result Result of operation * @param[out] user_data User data pointer @@ -154,6 +160,8 @@ typedef void (*companion_group_find_finish_cb)(int result, void *user_data); * @details Called when the maximum wait time elapsed after the companion_device_find() done. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[out] result Result of operation * @param[out] user_data User data pointer @@ -170,6 +178,8 @@ typedef void (*companion_device_find_finish_cb)(int result, void *user_data); * finished successfully. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[out] result Result of operation * @param[out] user_data User data pointer @@ -186,6 +196,8 @@ typedef void (*companion_device_invite_result_cb)(int result, void *user_data); * finished successfully. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[out] result Result of operation * @param[out] user_data User data pointer @@ -202,6 +214,8 @@ typedef void (*companion_device_eject_result_cb)(int result, void *user_data); * finished successfully. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @remarks The @a resp_data should not be released. * @remarks The @a resp_data can be used only in the callback. To use outside, make a copy. @@ -222,6 +236,8 @@ typedef void (*companion_send_data_finish_cb)(int result, char *resp_data, * companion_request_result_callback(). * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @remarks The @a cmd, @arg should not be released. * @remarks The @a cmd, @arg can be used only in the callback. To use outside, make a copy. @@ -243,6 +259,8 @@ typedef void (*companion_request_result_cb)(char *cmd, char *arg, int ret, /** * @brief Initializes companion-manager. * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @remarks You must release @a handle using companion_deinitialize(). * @@ -260,6 +278,8 @@ int companion_initialize(companion_h *handle); /** * @brief Deinitializes the companion-manager. * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @@ -279,6 +299,8 @@ int companion_deinitialize(companion_h handle); * @details This function is to allocate new group in local companion-manager. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] group_name Group name @@ -298,6 +320,8 @@ int companion_group_create(companion_h handle, char *group_name); * @details This function is find group resources in the network plus my local network. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] timeout Time to find @@ -322,6 +346,8 @@ int companion_group_find(companion_h handle, int timeout, * @details This function retrieves a list of group resources found. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] groups Group resource list @@ -345,6 +371,8 @@ int companion_group_get_found_groups(companion_h handle, * if group handle is my owns, then the API returns failure. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] group Group resource list @@ -371,6 +399,8 @@ int companion_group_join(companion_h handle, companion_group_h group, * @details This function allows my own device to be removed from the remote group. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] group Group handle @@ -397,6 +427,8 @@ int companion_group_leave(companion_h handle, companion_group_h group, * @details This function deletes a specific group and expels all devices in that group. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] group Group handle @@ -420,6 +452,8 @@ int companion_group_delete(companion_h handle, companion_group_h group); * @details This function combines two groups into one. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] dest_group Group handle to be united @@ -445,6 +479,8 @@ int companion_group_merge(companion_h handle, companion_group_h dest_group, * @details This function retrieves a devices list of group resources. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @remarks The @a devices should be released using companion_device_destroy(). * @@ -476,6 +512,8 @@ int companion_group_get_member_devices(companion_h handle, * @details This function will search for candidate devices that can be included in local group. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] timeout Time to find @@ -500,6 +538,8 @@ int companion_device_find(companion_h handle, int timeout, * @details This function retrieves a list of multiple owner enabled devices found. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] devices Device list @@ -522,6 +562,8 @@ int companion_device_get_found_devices(companion_h handle, * owners. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] timeout Time to find @@ -546,6 +588,8 @@ int companion_device_find_mowned_device(companion_h handle, int timeout, * @details This function retrieves a list of my owned devices found. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] devices Device list @@ -570,6 +614,8 @@ int companion_device_get_found_mowned_devices(companion_h handle, * user can enter the authentication information (i.e., PIN) or use the certificate. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] group Group handle @@ -601,6 +647,8 @@ int companion_device_invite(companion_h handle, companion_group_h group, * @details This function is used to kick away a remote devices in my local group. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] group Group handle @@ -629,6 +677,8 @@ int companion_device_eject(companion_h handle, companion_group_h group, * @details This function returns the local device information handle. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] device Local device handle @@ -648,6 +698,8 @@ int companion_device_get_my_device(companion_h handle, * @details This function returns current UUID of local device. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @remarks The @a uuid should not be released. * @remarks The @a uuid can be used only in the callback. To use outside, make a copy. @@ -1012,6 +1064,8 @@ int companion_device_information_get_device_type(companion_device_h device, * @details We can send data to devices included in group. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] device Device handle @@ -1041,6 +1095,8 @@ int companion_send_data(companion_h handle, companion_device_h device, char *dat * devices can inquire remotely group information and device information included in group. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] device Device handle @@ -1068,6 +1124,8 @@ int companion_request_create_group(companion_h handle, * certificate. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] group Group handle @@ -1094,6 +1152,8 @@ int companion_request_invite(companion_h handle, companion_group_h group, * @details This function is used to kick away a remote devices in a specific group. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] group Group handle @@ -1119,6 +1179,8 @@ int companion_request_eject(companion_h handle, companion_group_h group, * @details This function deletes a specific group and expels all devices in that group. * * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/internet * * @param[in] handle The companion manager handle * @param[in] group Group handle