Struct twitch_oauth2_auth_flow::TwitchAuthHook

pub struct TwitchAuthHook<C> { /* fields omitted */ }

Token generator using OAuth authorization code flow

Spins up a small webserver that listens for a response from the user after they are redirected to the redirect URL by twitch.

See [auth_flow] for a more integrated way of using this.

Make a new TwitchAuthHook and call generate_url() and make the user navigate to the url. Retrieve the token with receive_auth_token.

Example

use twitch_oauth2_auth_flow::TwitchAuthHook;
use twitch_oauth2::{TwitchToken, UserToken, Scope};
use url::Url;

let mut hook = TwitchAuthHook::new(
    twitch_oauth2::client::surf_http_client,  // or twitch_oauth2::client::reqwest_http_client
    "my_client_id".to_string(),
    "my_client_secret".to_string(),
    vec![Scope::ChatRead, Scope::ChatEdit, Scope::ChannelModerate, Scope::ModerationRead],
    Url::parse("http://localhost:8081/twitch/token")?,
)?;

let (url, _) = hook.generate_url();
give_url_to_user(url);
let token = hook.receive_auth_token();

Implementations

impl<RE, C, F> TwitchAuthHook<C> where
    RE: Error + Send + Sync + 'static,
    C: Copy + FnOnce(HttpRequest) -> F,
    F: Future<Output = Result<HttpResponse, RE>>, 

pub fn new(
    client: C,
    client_id: String,
    client_secret: String,
    scopes: impl Into<Option<Vec<Scope>>>,
    redirect_url: Url
) -> Result<TwitchAuthHook<C>, HookError<RE>>

Construct a new TwitchAuthHook

pub fn generate_url(&mut self) -> (Url, CsrfToken)

Generate the url and csrf token associated with this TwitchAuthHook

pub fn set_port(&mut self, port: u16)

Override the implicit port for the server as given by the redirect url.

Useful if the application is behind a reverse-proxy

pub async fn receive_auth_token(self) -> Result<UserToken, HookError<RE>>

Spin up a server to retrieve the token from the user.

This token will only be valid for around 4 hours, but you can refresh the token with UserToken::refresh_token