[−][src]Trait yup_oauth2::FlowDelegate

pub trait FlowDelegate: Clone {
    fn expired(&mut self, _: &DateTime<Utc>) { ... }

    fn denied(&mut self) { ... }

    fn pending(&mut self, _: &PollInformation) -> Retry { ... }

    fn redirect_uri(&self) -> Option<String> { ... }

    fn present_user_code(&mut self, pi: &PollInformation) { ... }

    fn present_user_url<S: AsRef<str> + Display>(
        &mut self, 
        url: S, 
        need_code: bool
    ) -> Box<dyn Future<Item = Option<String>, Error = Box<dyn Error + Send>> + Send> { ... }
}

FlowDelegate methods are called when an OAuth flow needs to ask the application what to do in certain cases.

Provided methods

fn expired(&mut self, _: &DateTime<Utc>)

Called if the request code is expired. You will have to start over in this case. This will be the last call the delegate receives. Given DateTime is the expiration date

fn denied(&mut self)

Called if the user denied access. You would have to start over. This will be the last call the delegate receives.

fn pending(&mut self, _: &PollInformation) -> Retry

Called as long as we are waiting for the user to authorize us. Can be used to print progress information, or decide to time-out.

If the returned Retry variant is a duration.

Notes

  • Only used in DeviceFlow. Return value will only be used if it is larger than the interval desired by the server.

fn redirect_uri(&self) -> Option<String>

Configure a custom redirect uri if needed.

fn present_user_code(&mut self, pi: &PollInformation)

The server has returned a user_code which must be shown to the user, along with the verification_url.

Notes

  • Will be called exactly once, provided we didn't abort during request_code phase.
  • Will only be called if the Authenticator's flow_type is FlowType::Device.

fn present_user_url<S: AsRef<str> + Display>(
    &mut self,
    url: S,
    need_code: bool
) -> Box<dyn Future<Item = Option<String>, Error = Box<dyn Error + Send>> + Send>

This method is used by the InstalledFlow. We need the user to navigate to a URL using their browser and potentially paste back a code (or maybe not). Whether they have to enter a code depends on the InstalledFlowReturnMethod used.

Loading content...

Implementors

impl FlowDelegate for DefaultFlowDelegate[src]

Loading content...