From: jkjo92 Date: Mon, 3 Jul 2017 09:39:00 +0000 (+0900) Subject: Add API Level Tags X-Git-Tag: submit/trunk/20170823.075128~90^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1154c2c5e21bd11945e6b753f2236c0ac12002ae;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git Add API Level Tags Change-Id: I4e889d31ac75b9c5b298f320f7edb5146d6f337c Signed-off-by: jkjo92 --- diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AccessToken.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AccessToken.cs old mode 100644 new mode 100755 index d92e265..4d185a0 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AccessToken.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AccessToken.cs @@ -21,6 +21,7 @@ namespace Tizen.Account.OAuth2 /// /// Class containing access token and related information. /// + /// 3 public class AccessToken { internal AccessToken() @@ -30,21 +31,25 @@ namespace Tizen.Account.OAuth2 /// /// The lifetime in seconds of the access token. /// + /// 3 public long ExpiresIn { get; internal set;} /// /// The access token issued by the authorization server. /// + /// 3 public string Token { get; internal set;} /// /// The scope of the access token. /// + /// 3 public IEnumerable Scope { get; internal set;} /// /// The type of the access token. /// + /// 3 public string TokenType { get; internal set;} } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthenticationScheme.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthenticationScheme.cs old mode 100644 new mode 100755 index 7a47fe6..6f385e7 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthenticationScheme.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthenticationScheme.cs @@ -20,22 +20,26 @@ namespace Tizen.Account.OAuth2 /// Enumerations for Client authentication scheme, used to sign client id and client secret accordingly. /// Default is Basic (http://tools.ietf.org/html/rfc2617#section-2) /// + /// 3 /// Facebook and Google does not support HTTP Basic Authentication, instead they require client credentials to be sent via request body. public enum AuthenticationScheme { /// /// HTTP Basic Authentication for client authentication /// + /// 3 Basic = 0, /// /// HTTP Basic Authentication for client authentication /// + /// 3 Digest, /// /// Client credentials are sent via request body /// + /// 3 RequestBody } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthorizationRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthorizationRequest.cs old mode 100644 new mode 100755 index 32c527d..e6a4a4d --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthorizationRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthorizationRequest.cs @@ -22,46 +22,55 @@ namespace Tizen.Account.OAuth2 /// /// The request parameters to be sent to authorization end point. /// + /// 3 public abstract class AuthorizationRequest { /// /// The desired response type from the OAuth authorization end point. /// + /// 3 public abstract string ResponseType { get; } /// /// Client secret credentials. /// + /// 3 public ClientCredentials ClientSecrets { get; set; } /// /// The scope of the access. /// + /// 3 public IEnumerable Scopes { get; set; } /// /// The authorization end point URL. /// + /// 3 public Uri AuthorizationEndpoint { get; set; } /// /// The redirection endpoint of the auhorization flow. /// + /// 3 public Uri RedirectionEndPoint { get; set; } /// /// The access token end point URL. /// + /// 3 public Uri TokenEndpoint { get; set; } /// /// The client's state which is maintained between request and response. /// + /// 3 public string State { get; set; } /// /// Custom key-value parameters to be sent to the server /// + /// 3 public IEnumerable> CustomData { get; set; } } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthorizationResponse.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthorizationResponse.cs old mode 100644 new mode 100755 index 6305e3c..c12422a --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthorizationResponse.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/AuthorizationResponse.cs @@ -22,6 +22,7 @@ namespace Tizen.Account.OAuth2 /// /// The response containing authroization code from the authorization server. /// + /// 3 public class AuthorizationResponse : IDisposable { private bool _disposed = false; @@ -35,6 +36,7 @@ namespace Tizen.Account.OAuth2 /// /// Destructor of the AuthorizationResponse class. /// + /// 3 ~AuthorizationResponse() { Dispose(false); @@ -43,11 +45,13 @@ namespace Tizen.Account.OAuth2 /// /// The authroization code. /// + /// 3 public string Code { get; internal set; } /// /// The state parameter present in authorization request. /// + /// 3 /// /// The value can be null depending on the server specifications. /// @@ -56,6 +60,7 @@ namespace Tizen.Account.OAuth2 /// /// Custom key-value parameter received from service provider /// + /// 3 /// /// The return value can be null depending on the server specifications. /// @@ -74,6 +79,7 @@ namespace Tizen.Account.OAuth2 /// /// Releases any unmanaged resources used by this object. /// + /// 3 public void Dispose() { Dispose(true); @@ -83,6 +89,7 @@ namespace Tizen.Account.OAuth2 /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/Authorizer.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/Authorizer.cs old mode 100644 new mode 100755 index 16fc6ad..bf0496c --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/Authorizer.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/Authorizer.cs @@ -26,6 +26,7 @@ namespace Tizen.Account.OAuth2 /// Refer to http://tools.ietf.org/html/rfc6749 about OAuth 2.0 protocols. /// Also service provider document needs to be referred for using end points and additional parameters. /// + /// 3 public abstract class Authorizer : IDisposable { @@ -35,6 +36,7 @@ namespace Tizen.Account.OAuth2 /// /// Constructor for Authoirzer instances /// + /// 3 public Authorizer() { int ret = Interop.Manager.Create(out _managerHandle); @@ -48,6 +50,7 @@ namespace Tizen.Account.OAuth2 /// /// Destructor of the Authorizer class. /// + /// 3 ~Authorizer() { Dispose(false); @@ -56,6 +59,7 @@ namespace Tizen.Account.OAuth2 /// /// Indicates if the current instance is already handling an authorization request /// + /// 3 public bool IsRequestInProgress { get @@ -67,6 +71,7 @@ namespace Tizen.Account.OAuth2 /// /// Authorizes the client with access toekn / authorizaion code in Implicit and Authorization Code grant flows respectively. /// + /// 3 /// /// /// An authorization request @@ -79,6 +84,7 @@ namespace Tizen.Account.OAuth2 /// /// Gets the access token in OAuth2 supported grant flows except Implicit Grant flow. /// + /// 3 /// /// /// A token request @@ -91,6 +97,7 @@ namespace Tizen.Account.OAuth2 /// /// Releases any unmanaged resources used by this object. /// + /// 3 public void Dispose() { Dispose(true); @@ -100,6 +107,7 @@ namespace Tizen.Account.OAuth2 /// /// Retrieves access token using a refresh token. /// + /// 3 /// Request containing refresh token /// The response containing access token. /// http://tizen.org/privilege/internet @@ -197,6 +205,7 @@ namespace Tizen.Account.OAuth2 /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentials.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentials.cs old mode 100644 new mode 100755 index edd49b7..3b6f58b --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentials.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentials.cs @@ -21,11 +21,13 @@ namespace Tizen.Account.OAuth2 /// /// Contains client credentials required for authentication in request-body /// + /// 3 public class ClientCredentials { /// /// The constructor /// + /// 3 public ClientCredentials() { @@ -34,11 +36,13 @@ namespace Tizen.Account.OAuth2 /// /// The client identifier /// + /// 3 public string Id { get; set; } /// /// The client secret /// + /// 3 public string Secret { get; set; } } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentialsAuthorizer.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentialsAuthorizer.cs old mode 100644 new mode 100755 index 6fc8922..b9d8f1c --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentialsAuthorizer.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentialsAuthorizer.cs @@ -23,11 +23,13 @@ namespace Tizen.Account.OAuth2 /// /// The ClientCredentialsAuthorizer is used to obtain access tokens using Client Credentials Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.4 /// + /// 3 public class ClientCredentialsAuthorizer : Authorizer { /// /// The constructor /// + /// 3 public ClientCredentialsAuthorizer() { @@ -36,6 +38,7 @@ namespace Tizen.Account.OAuth2 /// /// Authorization not supported through this API for this flow. /// + /// 3 /// Thrown when the operation is not supported public override Task AuthorizeAsync(AuthorizationRequest request) { @@ -46,6 +49,7 @@ namespace Tizen.Account.OAuth2 /// /// Refreshing access token is not supported in this flow. /// + /// 3 /// Thrown when the operation is not supported public override Task RefreshAccessTokenAsync(RefreshTokenRequest request) { @@ -57,6 +61,7 @@ namespace Tizen.Account.OAuth2 /// Retrieves access token using client credentials. /// The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.4.2 /// + /// 3 /// The token request /// The response containing access token. /// http://tizen.org/privilege/internet diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentialsTokenRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentialsTokenRequest.cs old mode 100644 new mode 100755 index 50fa43a..a57225f --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentialsTokenRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ClientCredentialsTokenRequest.cs @@ -21,11 +21,13 @@ namespace Tizen.Account.OAuth2 /// /// The class contains request parameters for retreiving access token in Client Credentials Grant flow. /// + /// 3 public class ClientCredentialsTokenRequest : TokenRequest { /// /// The constructor /// + /// 3 public ClientCredentialsTokenRequest() { @@ -34,6 +36,7 @@ namespace Tizen.Account.OAuth2 /// /// The grant type. /// + /// 3 public override string GrantType { get; } = "client_credentials"; } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizationRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizationRequest.cs old mode 100644 new mode 100755 index a53dc36..385a798 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizationRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizationRequest.cs @@ -25,6 +25,7 @@ namespace Tizen.Account.OAuth2 /// /// The constructor /// + /// 3 public CodeGrantAuthorizationRequest() { @@ -33,6 +34,7 @@ namespace Tizen.Account.OAuth2 /// /// The response type parameter to authorization server. /// + /// 3 public override string ResponseType { get; } = "code"; } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizer.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizer.cs old mode 100644 new mode 100755 index dd38565..bb7f1b5 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizer.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizer.cs @@ -24,11 +24,13 @@ namespace Tizen.Account.OAuth2 /// /// The CodeGrantAuthorizer is used to obtain access tokens and refresh tokens using Authorization Code Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.1 /// + /// 3 public class CodeGrantAuthorizer : Authorizer { /// /// The constructor /// + /// 3 public CodeGrantAuthorizer() { @@ -37,6 +39,7 @@ namespace Tizen.Account.OAuth2 /// /// Retrieves authorization code asynchronously. The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.1.1 /// + /// 3 /// The authorization request /// The response containing authorization code. /// http://tizen.org/privilege/internet @@ -52,6 +55,7 @@ namespace Tizen.Account.OAuth2 /// Retrieves access token by exchanging authorization code received using . /// The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.1.3 /// + /// 3 /// The token request /// The response containing access token. /// http://tizen.org/privilege/internet @@ -66,6 +70,7 @@ namespace Tizen.Account.OAuth2 /// /// Clears the cookies /// + /// 3 public void ClearCookies() { int ret = (int)OAuth2Error.None; @@ -80,6 +85,7 @@ namespace Tizen.Account.OAuth2 /// /// Clear the cache /// + /// 3 public void ClearCache() { int ret = (int)OAuth2Error.None; diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantTokenRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantTokenRequest.cs old mode 100644 new mode 100755 index c537f0e..38d21f9 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantTokenRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantTokenRequest.cs @@ -21,11 +21,13 @@ namespace Tizen.Account.OAuth2 /// /// The class contains request parameters for retreiving access token in Authorization Code Grant flow. /// + /// 3 public class CodeGrantTokenRequest : TokenRequest { /// /// The constructor /// + /// 3 public CodeGrantTokenRequest() { @@ -34,11 +36,13 @@ namespace Tizen.Account.OAuth2 /// /// The grant type /// + /// 3 public override string GrantType { get; } = "authorization_code"; /// /// The authoriztion code received from the authorization server. /// + /// 3 public string Code { get; set; } } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizationRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizationRequest.cs old mode 100644 new mode 100755 index 40732ab..5b0c50a --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizationRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizationRequest.cs @@ -24,6 +24,7 @@ namespace Tizen.Account.OAuth2 /// /// The constructor /// + /// 3 public ImplicitGrantAuthorizationRequest() { @@ -32,6 +33,7 @@ namespace Tizen.Account.OAuth2 /// /// The response type parameter to aturhoization server. /// + /// 3 public override string ResponseType { get; } = "token"; } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizer.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizer.cs old mode 100644 new mode 100755 index f86c046..c59dbee --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizer.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizer.cs @@ -24,11 +24,13 @@ namespace Tizen.Account.OAuth2 /// /// The ImplicitGrantAuthorizer is used to obtain access tokens using Implicit Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.2 /// + /// 3 public class ImplicitGrantAuthorizer : Authorizer { /// /// The constructor /// + /// 3 public ImplicitGrantAuthorizer() { @@ -37,6 +39,7 @@ namespace Tizen.Account.OAuth2 /// /// Retrieves access token asynchronously. The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.2.1 /// + /// 3 /// The authorization request /// The response containing access token. /// http://tizen.org/privilege/internet @@ -51,6 +54,7 @@ namespace Tizen.Account.OAuth2 /// /// Access token can be retreived implicitly using in this flow. /// + /// 3 /// Thrown when the operation is not supported public override Task GetAccessTokenAsync(TokenRequest request) { @@ -61,6 +65,7 @@ namespace Tizen.Account.OAuth2 /// /// Refreshing access token is not supported in this flow. /// + /// 3 /// Thrown when the operation is not supported public override Task RefreshAccessTokenAsync(RefreshTokenRequest request) { diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/OAuth2ErrorResponse.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/OAuth2ErrorResponse.cs old mode 100644 new mode 100755 index 89b2fac..82f1024 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/OAuth2ErrorResponse.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/OAuth2ErrorResponse.cs @@ -30,12 +30,14 @@ namespace Tizen.Account.OAuth2 /// /// The error response. /// + /// 3 public OAuth2ErrorResponse Error { get; internal set; } } /// /// Wrapper class contaning OAuth2 related error information /// + /// 3 public class OAuth2ErrorResponse { internal OAuth2ErrorResponse () @@ -46,21 +48,25 @@ namespace Tizen.Account.OAuth2 /// /// The server error code /// + /// 3 public int ServerErrorCode { get; internal set; } /// /// The platform error cocde /// + /// 3 public int PlatformErrorCode { get; internal set; } /// /// Error description /// + /// 3 public string Error { get; internal set; } /// /// URI of the error page. /// + /// 3 public string ErrorUri { get; internal set; } } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/RefreshToken.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/RefreshToken.cs old mode 100644 new mode 100755 index 37d09d5..5050563 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/RefreshToken.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/RefreshToken.cs @@ -19,6 +19,7 @@ namespace Tizen.Account.OAuth2 /// /// The refresh token which can be used to obtain new access token. /// + /// 3 public class RefreshToken { internal RefreshToken () @@ -29,6 +30,7 @@ namespace Tizen.Account.OAuth2 /// /// The refresh token issued to the client. /// + /// 3 public string Token { get; internal set; } } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/RefreshTokenRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/RefreshTokenRequest.cs old mode 100644 new mode 100755 index 45f4fae..0928ab6 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/RefreshTokenRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/RefreshTokenRequest.cs @@ -19,11 +19,13 @@ namespace Tizen.Account.OAuth2 /// /// The class contains request parameters for refreshing an access token. /// + /// 3 public class RefreshTokenRequest : TokenRequest { /// /// The constructor /// + /// 3 public RefreshTokenRequest() { @@ -32,11 +34,13 @@ namespace Tizen.Account.OAuth2 /// /// The grant type to be used /// + /// 3 public override string GrantType { get; } = "refresh_token"; /// /// The refresh token issued by authorization server. /// + /// 3 public string RefreshToken { get; set; } } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsAuthorizer.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsAuthorizer.cs old mode 100644 new mode 100755 index 5bb5c30..27ae244 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsAuthorizer.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsAuthorizer.cs @@ -24,11 +24,13 @@ namespace Tizen.Account.OAuth2 /// /// The ResourceOwnerPwdCredentialsAuthorizer is used to obtain access tokens using Resource Owner Password Credentials Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.3 /// + /// 3 public class ResourceOwnerPwdCredentialsAuthorizer : Authorizer { /// /// The constructor /// + /// 3 public ResourceOwnerPwdCredentialsAuthorizer() { @@ -37,6 +39,7 @@ namespace Tizen.Account.OAuth2 /// /// Authorization not supported through this API for this flow. /// + /// 3 /// Thrown when the operation is not supported public override Task AuthorizeAsync(AuthorizationRequest request) { @@ -48,6 +51,7 @@ namespace Tizen.Account.OAuth2 /// Retrieves access token by sending resource owner's password credentials. /// The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.3.2 /// + /// 3 /// The token request /// The response containing access token. /// http://tizen.org/privilege/internet diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsTokenRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsTokenRequest.cs old mode 100644 new mode 100755 index f7ffb8c..a0cf7fa --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsTokenRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsTokenRequest.cs @@ -19,6 +19,7 @@ namespace Tizen.Account.OAuth2 /// /// The class contains request parameters for retreiving access token in Resource Owner Password Credentials Grant flow. /// + /// 3 public class ResourceOwnerPwdCredentialsTokenRequest : TokenRequest { /// @@ -32,16 +33,19 @@ namespace Tizen.Account.OAuth2 /// /// The grant type /// + /// 3 public override string GrantType { get; } = "password"; /// /// The resource owner username /// + /// 3 public string Username { get; set; } /// /// The resource owner password /// + /// 3 public string Password { get; set; } } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/TokenRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/TokenRequest.cs old mode 100644 new mode 100755 index 66bdb10..1575c22 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/TokenRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/TokenRequest.cs @@ -22,46 +22,55 @@ namespace Tizen.Account.OAuth2 /// /// Abstract wrapper class containing OAuth 2.0 request parameters for requesting an access token. /// + /// 3 public abstract class TokenRequest { /// /// The Grant type /// + /// 3 public abstract string GrantType { get; } /// /// The client credentials /// + /// 3 public ClientCredentials ClientSecrets { get; set; } /// /// The access token end point URL. /// + /// 3 public Uri TokenEndpoint { get; set; } /// /// The redirection endpoint of the auhorization flow. /// + /// 3 public Uri RedirectionEndPoint { get; set; } /// /// The scope of the access request as described by https://tools.ietf.org/html/rfc6749#section-3.3 /// + /// 3 public IEnumerable Scopes { get; set; } /// /// Custom key-value parameters to be sent to the server /// + /// 3 public IEnumerable> CustomData { get; set; } /// /// Client authentication scheme. Default is Basic /// + /// 3 public AuthenticationScheme AuthenticationScheme { get; set; } = AuthenticationScheme.Basic; /// /// The client's state which is maintained between request and response. /// + /// 3 public string State { get; set; } } } diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/TokenResponse.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/TokenResponse.cs index ded80ea..0783268 100755 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/TokenResponse.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/TokenResponse.cs @@ -22,6 +22,7 @@ namespace Tizen.Account.OAuth2 /// /// The response from authroization server containing access token and an optional refresh token. /// + /// 3 public class TokenResponse { private bool _disposed = false; @@ -35,6 +36,7 @@ namespace Tizen.Account.OAuth2 /// /// Destructor of the AuthorizationResponse class. /// + /// 3 ~TokenResponse() { Dispose(false); @@ -43,11 +45,13 @@ namespace Tizen.Account.OAuth2 /// /// The access token /// + /// 3 public AccessToken AccessToken { get; internal set; } /// /// The state parameter present in authorization request. /// + /// 3 /// /// The value can be null depending on the server specifications. /// @@ -56,6 +60,7 @@ namespace Tizen.Account.OAuth2 /// /// The refresh token. The value will be null if authorization server doesn't return a refresh token. /// + /// 3 /// /// Issuing a refresh token is optional at the discretion of the authorization server. /// @@ -64,6 +69,7 @@ namespace Tizen.Account.OAuth2 /// /// Gets the value of the key received from service provider /// + /// 3 /// The value of respecitve key /// Thrown when the key does not exist or when there is an invalid parameter. public string GetCustomValue(string key) @@ -81,6 +87,7 @@ namespace Tizen.Account.OAuth2 /// /// Releases any unmanaged resources used by this object. /// + /// 3 public void Dispose() { Dispose(true); @@ -90,6 +97,7 @@ namespace Tizen.Account.OAuth2 /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. protected virtual void Dispose(bool disposing) {