Struct AppAccessToken

pub struct AppAccessToken {
    pub access_token: AccessToken,
    pub refresh_token: Option<RefreshToken>,
    /* private fields */
}

An App Access Token from the OAuth client credentials flow

Used for server-to-server requests. Use UserToken for requests that need to be in the context of an authenticated user.

In some contexts (i.e EventSub) an App Access Token can be used in the context of users that have authenticated the specific Client ID

Fields

access_token: AccessToken

The access token used to authenticate requests with

refresh_token: Option<RefreshToken>

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

Implementations

impl AppAccessToken

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

Assemble token without checks.

This is useful if you already have an app access token and want to use it with this library. Be careful however, as this function does not check if the token is valid or expired, nor if it is an app access token or user token.

Notes

If expires_in is None, we’ll assume token.is_elapsed() == true

pub async fn from_existing<C>( http_client: &C, access_token: AccessToken, refresh_token: impl Into<Option<RefreshToken>>, client_secret: ClientSecret, ) -> Result<AppAccessToken, ValidationError<<C as Client>::Error>>

where C: Client,

Available on crate feature client only.

Assemble token and validate it. Retrieves client_id and scopes.

pub fn from_response( response: TwitchTokenResponse, client_id: impl Into<ClientId>, client_secret: impl Into<ClientSecret>, ) -> AppAccessToken

Assemble token from twitch responses.

pub async fn get_app_access_token<C>( http_client: &C, client_id: ClientId, client_secret: ClientSecret, scopes: Vec<Scope>, ) -> Result<AppAccessToken, AppAccessTokenError<<C as Client>::Error>>

where C: Client,

Available on crate feature client only.

Generate an app access token via OAuth client credentials flow

Examples

use twitch_oauth2::{AccessToken, AppAccessToken};
// Make sure you enable the feature "reqwest" for twitch_oauth2 if you want to use reqwest
let client = reqwest::Client::builder()
    .redirect(reqwest::redirect::Policy::none())
    .build()?;
let token = AppAccessToken::get_app_access_token(
    &client,
    "my_client_id".into(),
    "my_client_secret".into(),
    vec![], // scopes
)
.await?;

pub fn get_app_access_token_request( client_id: &ClientIdRef, client_secret: &ClientSecretRef, scopes: Vec<Scope>, ) -> Request<Vec<u8>>

Get the request for getting an app access token.

Parse with TwitchTokenResponse::from_response and AppAccessToken::from_response

Trait Implementations

impl Clone for AppAccessToken

fn clone(&self) -> AppAccessToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppAccessToken

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

Formats the value using the given formatter.

impl TwitchToken for AppAccessToken

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<&UserNameRef>

Get the username associated to this token

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

Get the user id associated to this token

fn refresh_token<'a, 'life0, 'async_trait, C>( &'life0 mut self, http_client: &'a C, ) -> Pin<Box<dyn Future<Output = Result<(), RefreshTokenError<<C as Client>::Error>>> + Send + 'async_trait>>

where C: Client + 'async_trait, Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

Available on crate feature client only.

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.

fn validate_token<'a, 'life0, 'async_trait, C>( &'life0 self, http_client: &'a C, ) -> Pin<Box<dyn Future<Output = Result<ValidatedToken, ValidationError<<C as Client>::Error>>> + Send + 'async_trait>>

where Self: Sized + Sync + 'async_trait, C: Client + 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

Available on crate feature client only.

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

fn revoke_token<'a, 'async_trait, C>( self, http_client: &'a C, ) -> Pin<Box<dyn Future<Output = Result<(), RevokeTokenError<<C as Client>::Error>>> + Send + 'async_trait>>

where Self: Sized + Send + 'async_trait, C: Client + 'async_trait, 'a: 'async_trait,

Available on crate feature client only.

Revoke the token. See https://dev.twitch.tv/docs/authentication/revoke-tokens