Skip to main content

KickOAuth

Struct KickOAuth 

Source
pub struct KickOAuth { /* private fields */ }
Expand description

Holds OAuth credentials and client for Kick.com

Implementations§

Source§

impl KickOAuth

Source

pub fn from_env() -> Result<Self, Box<dyn Error>>

Creates a new OAuth client by loading credentials from environment variables

Required env vars:

  • KICK_CLIENT_ID
  • KICK_CLIENT_SECRET
  • KICK_REDIRECT_URI
Source

pub fn get_authorization_url( &self, scopes: Vec<&str>, ) -> (String, CsrfToken, PkceCodeVerifier)

Generates the authorization URL that users should visit

Pass the scopes you need (must match what you configured in your Kick app)

Returns (auth_url, csrf_token, pkce_verifier)

  • auth_url: The URL to send the user to
  • csrf_token: Save this! You’ll verify it matches when they return
  • pkce_verifier: REQUIRED! Pass this to exchange_code() later
Source

pub async fn exchange_code( &self, code: String, pkce_verifier: PkceCodeVerifier, ) -> Result<OAuthTokenResponse, Box<dyn Error>>

Exchanges the authorization code for an access token

After the user authorizes, Kick redirects to your callback with a code parameter. Pass that code AND the pkce_verifier from get_authorization_url() to this function.

Returns an OAuthTokenResponse with access_token, refresh_token, expires_in, etc.

Source

pub async fn refresh_token( &self, refresh_token: &str, ) -> Result<OAuthTokenResponse, Box<dyn Error>>

Refresh an access token using a refresh token

When your access token expires, use the refresh token from the original exchange_code() response to get a new one.

§Parameters
  • refresh_token: The refresh token from a previous token response
Source

pub async fn revoke_token(&self, token: &str) -> Result<(), Box<dyn Error>>

Revoke an access or refresh token

Invalidates the given token so it can no longer be used.

§Parameters
  • token: The access token or refresh token to revoke

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more