/**
* @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
/**
* @brief Gets error description.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free description
/**
* @brief Gets error uri.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free uri
/**
* @brief Gets the custom data.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free custom_value
/**
* @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
/**
* @brief Destroys oauth2_manager_h handle.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The oauth2_manager 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.
* @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.
/**
* @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.
* @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.
/**
* @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.
* @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.
/**
* @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.
* @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.
/**
* @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
/**
* @brief Clears the cookies.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The oauth2_manager handle.
/**
* @brief Clears the cache.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The oauth2_manager handle.
/**
* @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.
/**
* @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.
/**
* @brief Sets authorization end point URL.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets access token end point URL.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets redirection URL.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets refresh token end point URL.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @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.
/**
* @brief Sets response type.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets client id.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets client secret.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @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.
/**
* @brief Sets scope.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets state.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets grant type.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets authorization code.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets user name.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @brief Sets password.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @param[in] handle The request handle.
/**
* @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.
/**
* @brief Gets authorization end point URL.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free url
/**
* @brief Gets access token end point URL.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free url
/**
* @brief Gets redirection URL.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free url
/**
* @brief Gets refresh token end point URL.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free url
/**
* @brief Sets refresh token.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free refresh_token
/**
* @brief Gets response type.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free response_type
/**
* @brief Gets client id.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free client_id
/**
* @brief Gets client secret.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free client_secret
/**
* @brief Gets scope.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free scope
/**
* @brief Gets state.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free state
/**
* @brief Gets grant type.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free grant_type
/**
* @brief Get authorization code.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free code
/**
* @brief Gets user name.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free user_name
/**
* @brief Gets password.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free password
/**
* @brief Gets the custom value.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free custom_value
/**
* @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.
/**
* @brief Gets the authorization code.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free code
/**
* @brief Gets state.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free state
/**
* @brief Gets access token.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free access_token
/**
* @brief Gets token type.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free token_type
/**
* @brief Gets expiry time.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free expires_in
/**
* @brief Gets refresh token.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free refresh_token
/**
* @brief Gets scope.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free scope
/**
* @brief Gets error.
- * @since_tizen 2.4
+ * @since_tizen 3.0
* @privlevel public
*
* @remarks You must not free error
* @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
/**
* @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)
*
/**
* @brief Enumerations to set grant_type.
- * @since_tizen 2.4
+ * @since_tizen 3.0
*
* @see oauth2_request_set_grant_type()
*/
/**
* @brief Enumerations to set response_type.
- * @since_tizen 2.4
+ * @since_tizen 3.0
*
* @see oauth2_request_set_response_type()
*/
/**
* @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 */