Struct twitch_oauth2::tokens::UserToken

pub struct UserToken {
    pub access_token: AccessToken,
    pub login: String,
    pub user_id: String,
    pub refresh_token: Option<RefreshToken>,
    pub never_expiring: bool,
    // some fields omitted
}

An User Token from the OAuth implicit code flow or OAuth authorization code flow

Used for requests that need an authenticated user. See also AppAccessToken

See UserToken::builder for authenticating the user using the OAuth authorization code flow.

Fields

access_token: AccessToken

The access token used to authenticate requests with

login: String

Username of user associated with this token

user_id: String

User ID of the user associated with this token

refresh_token: Option<RefreshToken>

The refresh token used to extend the life of this user token

never_expiring: bool

Token will never expire

This is only true for old client IDs, like https://twitchapps.com/tmi and others

Implementations

impl UserToken

pub fn from_existing_unchecked(
    access_token: impl Into<AccessToken>,
    refresh_token: impl Into<Option<RefreshToken>>,
    client_id: impl Into<ClientId>,
    client_secret: impl Into<Option<ClientSecret>>,
    login: String,
    user_id: String,
    scopes: Option<Vec<Scope>>,
    expires_in: Option<Duration>
) -> UserToken

Assemble token without checks.

If expires_in is None, we’ll assume token.is_elapsed is always false

pub async fn from_existing<RE, C, F>(
    http_client: C,
    access_token: AccessToken,
    refresh_token: impl Into<Option<RefreshToken>>,
    client_secret: impl Into<Option<ClientSecret>>
) -> Result<UserToken, ValidationError<RE>> where
    RE: Error + Send + Sync + 'static,
    C: FnOnce(HttpRequest) -> F,
    F: Future<Output = Result<HttpResponse, RE>>, 

Assemble token and validate it. Retrieves login, client_id and scopes

If the token is already expired, this function will fail to produce a UserToken and return ValidationError::NotAuthorized

pub fn builder(
    client_id: ClientId,
    client_secret: ClientSecret,
    redirect_url: RedirectUrl
) -> Result<UserTokenBuilder, ParseError>

Create a UserTokenBuilder to get a token with the OAuth Authorization Code

pub fn set_secret(&mut self, secret: Option<ClientSecret>)

Set the client secret

Trait Implementations

impl Clone for UserToken

fn clone(&self) -> UserToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserToken

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

Formats the value using the given formatter.

impl TwitchToken for UserToken

fn token_type() -> BearerTokenType

Get the type of token.

fn client_id(&self) -> &ClientId

Client ID associated with the token. Twitch requires this in all helix API calls

fn token(&self) -> &AccessToken

Get the AccessToken for authenticating

fn login(&self) -> Option<&str>

Get the username associated to this token

fn user_id(&self) -> Option<&str>

Get the user id associated to this token

fn refresh_token<'life0, 'async_trait, RE, C, F>(
    &'life0 mut self,
    http_client: C
) -> Pin<Box<dyn Future<Output = Result<(), RefreshTokenError<RE>>> + Send + 'async_trait>> where
    Self: Sized,
    RE: Error + Send + Sync + 'static,
    C: FnOnce(HttpRequest) -> F + Send,
    F: Future<Output = Result<HttpResponse, RE>> + Send,
    RE: 'async_trait,
    C: 'async_trait,
    F: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Refresh this token, changing the token to a newer one

fn expires_in(&self) -> Duration

Get current lifetime of token.

fn scopes(&self) -> &[Scope]

Retrieve scopes attached to the token

fn is_elapsed(&self) -> bool

Returns whether or not the token is expired.

#[must_use]

fn validate_token<'life0, 'async_trait, RE, C, F>(
    &'life0 self,
    http_client: C
) -> Pin<Box<dyn Future<Output = Result<ValidatedToken, ValidationError<RE>>> + Send + 'async_trait>> where
    Self: Sized,
    RE: Error + Send + Sync + 'static,
    C: FnOnce(HttpRequest) -> F + Send,
    F: Future<Output = Result<HttpResponse, RE>> + Send,
    RE: 'async_trait,
    C: 'async_trait,
    F: 'async_trait,
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Validate this token. Should be checked on regularly, according to https://dev.twitch.tv/docs/authentication#validating-requests

#[must_use]

fn revoke_token<'async_trait, RE, C, F>(
    self,
    http_client: C
) -> Pin<Box<dyn Future<Output = Result<(), RevokeTokenError<RE>>> + Send + 'async_trait>> where
    Self: Sized,
    RE: Error + Send + Sync + 'static,
    C: FnOnce(HttpRequest) -> F + Send,
    F: Future<Output = Result<HttpResponse, RE>> + Send,
    RE: 'async_trait,
    C: 'async_trait,
    F: 'async_trait,
    Self: Send + 'async_trait, 

Revoke the token. See https://dev.twitch.tv/docs/authentication#revoking-access-tokens