Struct twitch_oauth2::tokens::AppAccessToken

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

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>,
    login: Option<String>,
    scopes: Option<Vec<Scope>>,
    expires_in: Option<Duration>
) -> AppAccessToken

Assemble token without checks.

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

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

Assemble token and validate it. Retrieves client_id and scopes.

pub async fn get_app_access_token<RE, C, F>(
    http_client: C,
    client_id: ClientId,
    client_secret: ClientSecret,
    scopes: Vec<Scope>
) -> Result<AppAccessToken, TokenError<RE>> where
    RE: Error + Send + Sync + 'static,
    C: Fn(HttpRequest) -> F + Send,
    F: Future<Output = Result<HttpResponse, RE>> + Send, 

Generate app access token via OAuth client credentials flow

Trait Implementations

impl Clone for AppAccessToken

fn clone(&self) -> AppAccessToken

Returns a copy of the value.

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