Struct yup_oauth2::InstalledFlow

pub struct InstalledFlow<FD: FlowDelegate, C: Connect + 'static> { /* fields omitted */ }

InstalledFlow provides tokens for services that follow the "Installed" OAuth flow. (See https://www.oauth.com/oauth2-servers/authorization/, https://developers.google.com/identity/protocols/OAuth2InstalledApp). You should use it wrapped inside an Authenticator to benefit from refreshing tokens and caching previously obtained authorization.

Methods

impl<'c, FD: 'static + FlowDelegate + Clone + Send, C: 'c + Connect> InstalledFlow<FD, C>

pub fn new(
    client: Client<C, Body>,
    fd: FD,
    secret: ApplicationSecret,
    method: InstalledFlowReturnMethod
) -> InstalledFlow<FD, C>

Starts a new Installed App auth flow. If HTTPRedirect is chosen as method and the server can't be started, the flow falls back to Interactive.

pub fn obtain_token<'a>(
    &mut self,
    scopes: Vec<String>
) -> impl 'a + Future<Item = Token, Error = RequestError> + Send

Handles the token request flow; it consists of the following steps: . Obtain a authorization code with user cooperation or internal redirect. . Obtain a token and refresh token using that code. . Return that token

It's recommended not to use the DefaultFlowDelegate, but a specialized one.

Trait Implementations

impl<FD: FlowDelegate + 'static + Send + Clone, C: Connect + 'static> GetToken for InstalledFlow<FD, C>

fn token<I, T>(
    &mut self,
    scopes: I
) -> Box<dyn Future<Item = Token, Error = RequestError> + Send> where
    T: Into<String>,
    I: IntoIterator<Item = T>, 

fn api_key(&mut self) -> Option<String>

fn application_secret(&self) -> ApplicationSecret

Return an application secret with at least token_uri, client_secret, and client_id filled in. This is used for refreshing tokens without interaction from the flow.