Struct sage_auth::refresh::RefreshBuilder

pub struct RefreshBuilder<'a> { /* fields omitted */ }

RefreshBuilder is used to generate a refresh request

Refresh a valid access_token. It can be used to keep a user logged in between gaming sessions and is preferred over storing the user's password in a file.

For example:

let resp = RefreshBuilder::new()
    .access_token("ACCESS_TOKEN")
    .client_token(Uuid::new_v4())
    .request()
    .await?;

Methods

impl<'a> RefreshBuilder<'a>

pub fn new() -> RefreshBuilder<'a>

pub fn client_token(&mut self, client_token: Uuid) -> &mut RefreshBuilder<'a>

Client token, the same as when you request access_token.

pub fn request_user(&mut self) -> &mut RefreshBuilder<'a>

Set to request user profile. If set, AuthenticateResponse will contain the user profile.

pub fn access_token(&mut self, access_token: &'a str) -> &mut RefreshBuilder<'a>

access_token to invalidate.

pub fn server<T: IntoUrl>(
    &mut self,
    server: T
) -> Result<&mut RefreshBuilder<'a>>

Set base url, default is https://authserver.mojang.com.

pub fn endpoint(&mut self, endpoint: &'a str) -> &mut RefreshBuilder<'a>

set endpoint, default is /authenticate.

pub async fn request<'_>(&'_ mut self) -> Result<RefreshResponse>

Make a request with the given parameters.

Trait Implementations

impl<'_> Default for RefreshBuilder<'_>

fn default() -> RefreshBuilder<'static>

Returns the "default value" for a type.