Struct twitch_oauth2::tokens::AppAccessToken

source ·

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

Expand description

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§

source §

impl AppAccessToken

source

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.

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

Examples found in repository ?

src/tokens/app_access_token.rs (lines 128-135)

    pub async fn from_existing<'a, RE, C>(
        http_client: &'a C,
        access_token: AccessToken,
        refresh_token: impl Into<Option<RefreshToken>>,
        client_secret: ClientSecret,
    ) -> Result<AppAccessToken, ValidationError<<C as Client<'a>>::Error>>
    where
        C: Client<'a>,
    {
        let token = access_token;
        let validated = token.validate_token(http_client).await?;
        Ok(Self::from_existing_unchecked(
            token,
            refresh_token.into(),
            validated.client_id,
            client_secret,
            validated.scopes,
            validated.expires_in,
        ))
    }

    /// Assemble token from twitch responses.
    pub fn from_response(
        response: crate::id::TwitchTokenResponse,
        client_id: impl Into<ClientId>,
        client_secret: impl Into<ClientSecret>,
    ) -> AppAccessToken {
        let expires_in = response.expires_in();
        AppAccessToken::from_existing_unchecked(
            response.access_token,
            response.refresh_token,
            client_id.into(),
            client_secret,
            response.scopes,
            expires_in,
        )
    }

source

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

Assemble token and validate it. Retrieves client_id and scopes.

source

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

Assemble token from twitch responses.

Examples found in repository ?

src/tokens/app_access_token.rs (line 174)

    pub async fn get_app_access_token<'a, C>(
        http_client: &'a C,
        client_id: ClientId,
        client_secret: ClientSecret,
        scopes: Vec<Scope>,
    ) -> Result<AppAccessToken, AppAccessTokenError<<C as Client<'a>>::Error>>
    where
        C: Client<'a>,
    {
        let req = Self::get_app_access_token_request(&client_id, &client_secret, scopes);

        let resp = http_client
            .req(req)
            .await
            .map_err(AppAccessTokenError::Request)?;

        let response = crate::id::TwitchTokenResponse::from_response(&resp)?;
        let app_access = AppAccessToken::from_response(response, client_id, client_secret);

        Ok(app_access)
    }

source

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

Generate app access token via OAuth client credentials flow

source

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

Get the request for getting a app access token.

Parse with TwitchTokenResponse::from_response and AppAccessToken::from_response

Examples found in repository ?

src/tokens/app_access_token.rs (line 166)

    pub async fn get_app_access_token<'a, C>(
        http_client: &'a C,
        client_id: ClientId,
        client_secret: ClientSecret,
        scopes: Vec<Scope>,
    ) -> Result<AppAccessToken, AppAccessTokenError<<C as Client<'a>>::Error>>
    where
        C: Client<'a>,
    {
        let req = Self::get_app_access_token_request(&client_id, &client_secret, scopes);

        let resp = http_client
            .req(req)
            .await
            .map_err(AppAccessTokenError::Request)?;

        let response = crate::id::TwitchTokenResponse::from_response(&resp)?;
        let app_access = AppAccessToken::from_response(response, client_id, client_secret);

        Ok(app_access)
    }