Class Authorizer
Definition
- Assembly:
- Tizen.Account.OAuth2.dll
An abstract class to represent various OAuth 2.0 authorization code flows. 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.
C#Copypublic abstract class Authorizer : IDisposable
- Inheritance
-
objectAuthorizer
- Derived
- Implements
-
System.IDisposable
Constructors
Declaration
C#Copypublic Authorizer()
Properties
IsRequestInProgress
Indicates if the current instance is already handling an authorization request
Declaration
C#Copypublic bool IsRequestInProgress { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Methods
AuthorizeAsync(AuthorizationRequest)
Authorizes the client with access toekn / authorizaion code in Implicit and Authorization Code grant flows respectively.
Declaration
C#Copypublic virtual Task<AuthorizationResponse> AuthorizeAsync(AuthorizationRequest request)
Parameters
| Type | Name | Description |
|---|---|---|
| AuthorizationRequest | request | An authorization request |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TResult><AuthorizationResponse> | The authorization response from server |
Declaration
C#Copypublic void Dispose()
Dispose(bool)
Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
Declaration
C#Copyprotected virtual void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing | If true, disposes any disposable objects. If false, does not dispose disposable objects. |
Declaration
C#Copyprotected ~Authorizer()
GetAccessTokenAsync(TokenRequest)
Gets the access token in OAuth2 supported grant flows except Implicit Grant flow.
Declaration
C#Copypublic virtual Task<TokenResponse> GetAccessTokenAsync(TokenRequest request)
Parameters
| Type | Name | Description |
|---|---|---|
| TokenRequest | request | A token request |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TResult><TokenResponse> | The response from server |
RefreshAccessTokenAsync(RefreshTokenRequest)
Retrieves access token using a refresh token.
Declaration
C#Copypublic virtual Task<TokenResponse> RefreshAccessTokenAsync(RefreshTokenRequest request)
Parameters
| Type | Name | Description |
|---|---|---|
| RefreshTokenRequest | request | Request containing refresh token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TResult><TokenResponse> | The response containing access token. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentException | Thrown when method failed due to invalid argumets |
| OAuth2Exception | Thrown when method fails due to server error |