C# Class Google.Apis.Auth.OAuth2.UserCredential

OAuth 2.0 credential for accessing protected resources using an access token, as well as optionally refreshing the access token when it expires using a refresh token.
Inheritance: IHttpExecuteInterceptor, IHttpUnsuccessfulResponseHandler, IConfigurableHttpClientInitializer
Afficher le fichier Open project: Gainedge/BetterExplorer Class Usage Examples

Méthodes publiques

Méthode Description
HandleResponseAsync ( Google.Apis.Http.HandleUnsuccessfulResponseArgs args ) : Task
Initialize ( Google.Apis.Http.ConfigurableHttpClient httpClient ) : void
InterceptAsync ( HttpRequestMessage request, CancellationToken taskCancellationToken ) : Task

Default implementation is to try to refresh the access token if there is no access token or if we are 1 minute away from expiration. If token server is unavailable, it will try to use the access token even if has expired. If successful, it will call IAccessMethod.Intercept.

RefreshTokenAsync ( CancellationToken taskCancellationToken ) : Task

Refreshes the token by calling to Google.Apis.Auth.OAuth2.Flows.IAuthorizationCodeFlow.RefreshTokenAsync. Then it updates the TokenResponse with the new token instance.

UserCredential ( IAuthorizationCodeFlow flow, string userId, Google.Apis.Auth.OAuth2.Responses.TokenResponse token ) : System

Constructs a new credential instance.

Method Details

HandleResponseAsync() public méthode

public HandleResponseAsync ( Google.Apis.Http.HandleUnsuccessfulResponseArgs args ) : Task
args Google.Apis.Http.HandleUnsuccessfulResponseArgs
Résultat Task

Initialize() public méthode

public Initialize ( Google.Apis.Http.ConfigurableHttpClient httpClient ) : void
httpClient Google.Apis.Http.ConfigurableHttpClient
Résultat void

InterceptAsync() public méthode

Default implementation is to try to refresh the access token if there is no access token or if we are 1 minute away from expiration. If token server is unavailable, it will try to use the access token even if has expired. If successful, it will call IAccessMethod.Intercept.
public InterceptAsync ( HttpRequestMessage request, CancellationToken taskCancellationToken ) : Task
request System.Net.Http.HttpRequestMessage
taskCancellationToken System.Threading.CancellationToken
Résultat Task

RefreshTokenAsync() public méthode

Refreshes the token by calling to Google.Apis.Auth.OAuth2.Flows.IAuthorizationCodeFlow.RefreshTokenAsync. Then it updates the TokenResponse with the new token instance.
public RefreshTokenAsync ( CancellationToken taskCancellationToken ) : Task
taskCancellationToken System.Threading.CancellationToken Cancellation token to cancel an operation.
Résultat Task

UserCredential() public méthode

Constructs a new credential instance.
public UserCredential ( IAuthorizationCodeFlow flow, string userId, Google.Apis.Auth.OAuth2.Responses.TokenResponse token ) : System
flow IAuthorizationCodeFlow Authorization code flow.
userId string User identifier.
token Google.Apis.Auth.OAuth2.Responses.TokenResponse An initial token for the user.
Résultat System