From 36feb787844438ebccd930df8a1ad3db758ff809 Mon Sep 17 00:00:00 2001 From: jkjo92 Date: Mon, 28 Mar 2016 17:02:15 +0900 Subject: [PATCH] api decription change since_tize 2.4 => since_tizen 3.0 Change-Id: Ia45c9f5d4ba57af31793e277b33324f9a2272d6c Signed-off-by: jkjo92 --- include/oauth2_error.h | 10 +++---- include/oauth2_manager.h | 28 +++++++++---------- include/oauth2_request.h | 68 +++++++++++++++++++++++------------------------ include/oauth2_response.h | 24 ++++++++--------- include/oauth2_types.h | 8 +++--- 5 files changed, 69 insertions(+), 69 deletions(-) mode change 100644 => 100755 include/oauth2_error.h mode change 100644 => 100755 include/oauth2_manager.h mode change 100644 => 100755 include/oauth2_request.h mode change 100644 => 100755 include/oauth2_response.h mode change 100644 => 100755 include/oauth2_types.h diff --git a/include/oauth2_error.h b/include/oauth2_error.h old mode 100644 new mode 100755 index af5aa74..f24bee3 --- a/include/oauth2_error.h +++ b/include/oauth2_error.h @@ -35,14 +35,14 @@ /** * @brief The structure type for OAuth2 Error handle. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public */ typedef struct oauth2_error_s *oauth2_error_h; /** * @brief Gets error code. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free server_error_code and platform_error_code @@ -61,7 +61,7 @@ OAUTH2_API int oauth2_error_get_code(oauth2_error_h handle, int *server_error_co /** * @brief Gets error description. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free description @@ -79,7 +79,7 @@ OAUTH2_API int oauth2_error_get_description(oauth2_error_h handle, char **descri /** * @brief Gets error uri. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free uri @@ -97,7 +97,7 @@ OAUTH2_API int oauth2_error_get_uri(oauth2_error_h handle, char **uri); /** * @brief Gets the custom data. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free custom_value diff --git a/include/oauth2_manager.h b/include/oauth2_manager.h old mode 100644 new mode 100755 index 58a7aa1..2837512 --- a/include/oauth2_manager.h +++ b/include/oauth2_manager.h @@ -43,14 +43,14 @@ /** * @brief The structure type for OAuth2 Manager handle. - * @since_tizen 2.4 + * @since_tizen 3.0 */ typedef struct oauth2_manager_s *oauth2_manager_h; /** * @brief Creates oauth2_manager_h handle. * @remarks It must be freed using oauth2_manager_destroy(). - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[out] handle The created handle @@ -66,7 +66,7 @@ OAUTH2_API int oauth2_manager_create(oauth2_manager_h *handle); /** * @brief Destroys oauth2_manager_h handle. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The oauth2_manager handle. @@ -80,7 +80,7 @@ OAUTH2_API int oauth2_manager_destroy(oauth2_manager_h handle); /** * @brief Called when the oauth2_manager_request_token() resopnse comes. - * @since_tizen 2.4 + * @since_tizen 3.0 * * param[in] response The response. The response must be released using oauth2_response_destroy(). * param[in] user_data The user data passed from the callback function. @@ -94,7 +94,7 @@ typedef void (*oauth2_token_cb)(oauth2_response_h response, void *user_data); * @brief Request OAuth 2.0 access token. * @details The response is delivered via oauth2_token_cb(). * "internet" privilege is required to call this API. Note, only one pending request is allowed. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The oauth2_manager_handle. @@ -119,7 +119,7 @@ OAUTH2_API int oauth2_manager_request_token(oauth2_manager_h handle, oauth2_requ /** * @brief Called when oauth2_manager_request_authorization_grant() response comes. - * @since_tizen 2.4 + * @since_tizen 3.0 * * @param[in] response The response. The response must be released using oauth2_response_destroy(). * param[in] user_data The user data passed from the callback function. @@ -133,7 +133,7 @@ typedef void (*oauth2_auth_grant_cb)(oauth2_response_h response, void *user_data * @brief Request authorization grant. * @details The response is delivered via oauth2_auth_grant_cb(). * "internet" privilege is required to call this API. Note, only one pending request is allowed at a time. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The oauth2_manager handle. @@ -158,7 +158,7 @@ OAUTH2_API int oauth2_manager_request_authorization_grant(oauth2_manager_h handl /** * @brief Called when oauth2_manager_request_access_token() response comes. - * @since_tizen 2.4 + * @since_tizen 3.0 * * @param[in] response The response. The response must be released using oauth2_response_destroy(). * param[in] user_data The user data passed from the callback function. @@ -172,7 +172,7 @@ typedef void (*oauth2_access_token_cb)(oauth2_response_h response, void *user_da * @brief Requests an access token. * @details The response is delivered via oauth2_access_token_cb() callback. * "internet" privilege is required to call this API. Note, only one pending request is allowed at a time. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The oauth2_manager handle. @@ -197,7 +197,7 @@ OAUTH2_API int oauth2_manager_request_access_token(oauth2_manager_h handle, oaut /** * @brief Called when oauth2_manager_refresh_access_token() response comes. - * @since_tizen 2.4 + * @since_tizen 3.0 * * @param[in] response The response. The response must be released using oauth2_response_destroy(). * param[in] user_data The user data passed from the callback function. @@ -211,7 +211,7 @@ typedef void (*oauth2_refresh_token_cb)(oauth2_response_h response, void *user_d * @brief Requests a refresh token. * @details The response is delivered via oauth2_refresh_token_cb() callback. * "internet" privilege is required to call this API. Note, only one pending request is allowed at a time. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The oauth2_manager handle. @@ -236,7 +236,7 @@ OAUTH2_API int oauth2_manager_refresh_access_token(oauth2_manager_h handle, oaut /** * @brief Returns whether oauth2_manager related request is pending. - * @since_tizen 2.4 + * @since_tizen 3.0 * * @param[in] handle The auth2_manager handle. * @retval false No pending request @@ -246,7 +246,7 @@ OAUTH2_API bool oauth2_manager_is_request_in_progress(oauth2_manager_h handle); /** * @brief Clears the cookies. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The oauth2_manager handle. @@ -261,7 +261,7 @@ OAUTH2_API int oauth2_manager_clear_cookies(oauth2_manager_h handle); /** * @brief Clears the cache. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The oauth2_manager handle. diff --git a/include/oauth2_request.h b/include/oauth2_request.h old mode 100644 new mode 100755 index bd6cf4a..ae90fb7 --- a/include/oauth2_request.h +++ b/include/oauth2_request.h @@ -35,14 +35,14 @@ /** * @brief The structure type for OAuth2 Request handle. - * @since_tizen 2.4 + * @since_tizen 3.0 */ typedef struct oauth2_request_s *oauth2_request_h; /** * @brief Creates oauth2_request_h handle. * @details The handle must be freed via oauth2_request_destroy(). - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[out] handle The created oauth2_request handle, else NULL for error cases. @@ -57,7 +57,7 @@ OAUTH2_API int oauth2_request_create(oauth2_request_h *handle); /** * @brief Destroys oauth2_request_h handle. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The oauth2_request handle to destory. @@ -71,7 +71,7 @@ OAUTH2_API int oauth2_request_destroy(oauth2_request_h handle); /** * @brief Sets authorization end point URL. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -87,7 +87,7 @@ OAUTH2_API int oauth2_request_set_auth_end_point_url(oauth2_request_h handle, co /** * @brief Sets access token end point URL. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -103,7 +103,7 @@ OAUTH2_API int oauth2_request_set_token_end_point_url(oauth2_request_h handle, c /** * @brief Sets redirection URL. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -119,7 +119,7 @@ OAUTH2_API int oauth2_request_set_redirection_url(oauth2_request_h handle, const /** * @brief Sets refresh token end point URL. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -135,7 +135,7 @@ OAUTH2_API int oauth2_request_set_refresh_token_url(oauth2_request_h handle, con /** * @brief Sets refresh token. Used mostly while using oauth2_manager_refresh_access_token(). - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -151,7 +151,7 @@ OAUTH2_API int oauth2_request_set_refresh_token(oauth2_request_h handle, char *r /** * @brief Sets response type. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -167,7 +167,7 @@ OAUTH2_API int oauth2_request_set_response_type(oauth2_request_h handle, oauth2_ /** * @brief Sets client id. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -183,7 +183,7 @@ OAUTH2_API int oauth2_request_set_client_id(oauth2_request_h handle, const char /** * @brief Sets client secret. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -199,7 +199,7 @@ OAUTH2_API int oauth2_request_set_client_secret(oauth2_request_h handle, const c /** * @brief Sets client authentication type. Default is OAUTH2_CLIENT_AUTHENTICATION_TYPE_BASIC. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -218,7 +218,7 @@ OAUTH2_API int oauth2_request_set_client_authentication_type(oauth2_request_h ha /** * @brief Sets scope. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -234,7 +234,7 @@ OAUTH2_API int oauth2_request_set_scope(oauth2_request_h handle, const char *sco /** * @brief Sets state. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -250,7 +250,7 @@ OAUTH2_API int oauth2_request_set_state(oauth2_request_h handle, const char *sta /** * @brief Sets grant type. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -266,7 +266,7 @@ OAUTH2_API int oauth2_request_set_grant_type(oauth2_request_h handle, oauth2_gra /** * @brief Sets authorization code. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -284,7 +284,7 @@ OAUTH2_API int oauth2_request_set_authorization_code(oauth2_request_h handle, co /** * @brief Sets user name. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -300,7 +300,7 @@ OAUTH2_API int oauth2_request_set_user_name(oauth2_request_h handle, const char /** * @brief Sets password. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -316,7 +316,7 @@ OAUTH2_API int oauth2_request_set_password(oauth2_request_h handle, const char * /** * @brief Adds custom key-value pair to the request. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The request handle. @@ -335,7 +335,7 @@ OAUTH2_API int oauth2_request_add_custom_data(oauth2_request_h handle, const cha /** * @brief Gets authorization end point URL. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free url @@ -353,7 +353,7 @@ OAUTH2_API int oauth2_request_get_auth_end_point_url(oauth2_request_h handle, ch /** * @brief Gets access token end point URL. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free url @@ -371,7 +371,7 @@ OAUTH2_API int oauth2_request_get_token_end_point_url(oauth2_request_h handle, c /** * @brief Gets redirection URL. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free url @@ -389,7 +389,7 @@ OAUTH2_API int oauth2_request_get_redirection_url(oauth2_request_h handle, char /** * @brief Gets refresh token end point URL. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free url @@ -407,7 +407,7 @@ OAUTH2_API int oauth2_request_get_refresh_token_url(oauth2_request_h handle, cha /** * @brief Sets refresh token. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free refresh_token @@ -425,7 +425,7 @@ OAUTH2_API int oauth2_request_get_refresh_token(oauth2_request_h handle, char ** /** * @brief Gets response type. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free response_type @@ -443,7 +443,7 @@ OAUTH2_API int oauth2_request_get_response_type(oauth2_request_h handle, oauth2_ /** * @brief Gets client id. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free client_id @@ -461,7 +461,7 @@ OAUTH2_API int oauth2_request_get_client_id(oauth2_request_h handle, char **clie /** * @brief Gets client secret. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free client_secret @@ -479,7 +479,7 @@ OAUTH2_API int oauth2_request_get_client_secret(oauth2_request_h handle, char ** /** * @brief Gets scope. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free scope @@ -497,7 +497,7 @@ OAUTH2_API int oauth2_request_get_scope(oauth2_request_h handle, char **scope); /** * @brief Gets state. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free state @@ -515,7 +515,7 @@ OAUTH2_API int oauth2_request_get_state(oauth2_request_h handle, char **state); /** * @brief Gets grant type. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free grant_type @@ -533,7 +533,7 @@ OAUTH2_API int oauth2_request_get_grant_type(oauth2_request_h handle, oauth2_gra /** * @brief Get authorization code. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free code @@ -551,7 +551,7 @@ OAUTH2_API int oauth2_request_get_authorization_code(oauth2_request_h handle, ch /** * @brief Gets user name. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free user_name @@ -569,7 +569,7 @@ OAUTH2_API int oauth2_request_get_user_name(oauth2_request_h handle, char **user /** * @brief Gets password. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free password @@ -587,7 +587,7 @@ OAUTH2_API int oauth2_request_get_password(oauth2_request_h handle, char **passw /** * @brief Gets the custom value. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free custom_value diff --git a/include/oauth2_response.h b/include/oauth2_response.h old mode 100644 new mode 100755 index 9f57cbb..e6b0413 --- a/include/oauth2_response.h +++ b/include/oauth2_response.h @@ -35,13 +35,13 @@ /** * @brief The structure type for OAuth2 Response handle. - * @since_tizen 2.4 + * @since_tizen 3.0 */ typedef struct oauth2_response_s *oauth2_response_h; /** * @brief Destroys the received oauth2_response_h handle. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @param[in] handle The response handle. @@ -55,7 +55,7 @@ OAUTH2_API int oauth2_response_destroy(oauth2_response_h handle); /** * @brief Gets the authorization code. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free code @@ -75,7 +75,7 @@ OAUTH2_API int oauth2_response_get_authorization_code(oauth2_response_h handle, /** * @brief Gets state. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free state @@ -93,7 +93,7 @@ OAUTH2_API int oauth2_response_get_state(oauth2_response_h handle, char **state) /** * @brief Gets access token. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free access_token @@ -111,7 +111,7 @@ OAUTH2_API int oauth2_response_get_access_token(oauth2_response_h handle, char * /** * @brief Gets token type. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free token_type @@ -129,7 +129,7 @@ OAUTH2_API int oauth2_response_get_token_type(oauth2_response_h handle, char **t /** * @brief Gets expiry time. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free expires_in @@ -147,7 +147,7 @@ OAUTH2_API int oauth2_response_get_expires_in(oauth2_response_h handle, long lon /** * @brief Gets refresh token. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free refresh_token @@ -165,7 +165,7 @@ OAUTH2_API int oauth2_response_get_refresh_token(oauth2_response_h handle, char /** * @brief Gets scope. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free scope @@ -183,7 +183,7 @@ OAUTH2_API int oauth2_response_get_scope(oauth2_response_h handle, char **scope) /** * @brief Gets error. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free error @@ -198,14 +198,14 @@ OAUTH2_API int oauth2_response_get_scope(oauth2_response_h handle, char **scope) * @retval #OAUTH2_ERROR_VALUE_NOT_FOUND Value not found * * @see @oauth2_error_h - * @since_tizen 2.4 + * @since_tizen 3.0 */ OAUTH2_API int oauth2_response_get_error(oauth2_response_h handle, oauth2_error_h *error); /** * @brief Gets the custom data. * @details Some service providers send additional keys not specified in OAuth 2.0 RFC. To get those additional fields this API needs to be used. - * @since_tizen 2.4 + * @since_tizen 3.0 * @privlevel public * * @remarks You must not free custom_value diff --git a/include/oauth2_types.h b/include/oauth2_types.h old mode 100644 new mode 100755 index 820773f..d841d60 --- a/include/oauth2_types.h +++ b/include/oauth2_types.h @@ -36,7 +36,7 @@ /** * @brief Enumerations for Client authentication scheme, used to sign client id and client secret accordingly. - * @since_tizen 2.4 + * @since_tizen 3.0 * @remarks Facebook and Google does not support HTTP Basic Authentication, instead they require client credentials to be sent via request body. * Default is OAUTH2_CLIENT_AUTHENTICATION_TYPE_BASIC (http://tools.ietf.org/html/rfc2617#section-2) * @@ -52,7 +52,7 @@ typedef enum { /** * @brief Enumerations to set grant_type. - * @since_tizen 2.4 + * @since_tizen 3.0 * * @see oauth2_request_set_grant_type() */ @@ -67,7 +67,7 @@ typedef enum { /** * @brief Enumerations to set response_type. - * @since_tizen 2.4 + * @since_tizen 3.0 * * @see oauth2_request_set_response_type() */ @@ -80,7 +80,7 @@ typedef enum { /** * @brief Enumerations of error codes for oauth2 APIs. - * @since_tizen 2.4 + * @since_tizen 3.0 */ typedef enum { OAUTH2_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ -- 2.7.4