Struct Authorization

pub struct Authorization {
    pub client_id: String,
    /* private fields */
}

Provides for continuing authorization of the app.

Fields

client_id: String

Dropbox app key

Implementations

impl Authorization

pub fn client_id(&self) -> &str

Get the client ID for this authorization.

pub fn from_auth_code( client_id: String, flow_type: Oauth2Type, auth_code: String, redirect_uri: Option<String>, ) -> Self

Create a new instance using the authorization code provided upon redirect back to your app (or via manual user entry if not using a redirect URI) after the user logs in.

Requires the client ID; the type of OAuth2 flow being used (including the client secret or the PKCE challenge); the authorization code; and the redirect URI used for the original authorization request, if any.

pub fn save(&self) -> Option<String>

Save the authorization state to a string which can be reloaded later.

Returns None if the state cannot be saved (e.g. authorization has not completed getting a token yet).

pub fn load(client_id: String, saved: &str) -> Option<Self>

Reload a saved authorization state produced by save.

Returns None if the string could not be recognized. In this case, you should start the authorization procedure from scratch.

Note that a loaded authorization state is not necessarily still valid and may produce Authentication errors. In such a case you should also start the authorization procedure from scratch.

pub fn from_refresh_token(client_id: String, refresh_token: String) -> Self

Recreate the authorization from a refresh token obtained using the Oauth2Type::PKCE flow.

pub fn from_client_secret_refresh_token( client_id: String, client_secret: String, refresh_token: String, ) -> Self

Recreate the authorization from a refresh token obtained using the Oauth2Type::AuthorizationCode flow. This requires the client secret as well.

pub fn from_long_lived_access_token(access_token: String) -> Self

👎Deprecated

Recreate the authorization from a long-lived access token. This token cannot be refreshed; any call to obtain_access_token_async will simply return the given token. Therefore this requires neither client ID or client secret.

Long-lived tokens are deprecated and the ability to generate them will be removed in the future.

pub fn obtain_access_token( &mut self, sync_client: impl NoauthClient, ) -> Result<String, Error>

Available on crate feature sync_routes only.

Compatibility shim for working with sync HTTP clients.

pub async fn obtain_access_token_async( &mut self, client: impl NoauthClient, ) -> Result<String, Error>

Obtain an access token. Use this to complete the authorization process, or to obtain an updated token when a short-lived access token has expired.

Trait Implementations

impl Clone for Authorization

fn clone(&self) -> Authorization

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Authorization

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.