Struct AuthClient 

pub struct AuthClient(/* private fields */);

Available on crate feature wasm-js only.

The tool for managing authentication and identity.

It maintains the state of the user’s identity and provides methods for authentication.

Implementations

impl AuthClient

pub fn builder() -> AuthClientBuilder

Create a new [AuthClientBuilder] for building an AuthClient.

pub async fn new() -> Result<Self, AuthClientError>

Creates a new AuthClient with default options.

pub async fn new_with_options( options: AuthClientCreateOptions, ) -> Result<Self, AuthClientError>

Creates a new AuthClient with the provided options.

pub fn idle_manager(&self) -> Option<IdleManager>

Returns the idle manager if it exists.

pub fn identity(&self) -> Arc<dyn Identity>

Returns the identity of the user.

pub fn principal(&self) -> Result<Principal, String>

Returns the principal of the user.

pub fn is_authenticated(&self) -> bool

Checks if the user is authenticated.

pub fn login(&self)

Logs the user in with default options.

pub fn login_with_options(&self, options: AuthClientLoginOptions)

Logs the user in with the provided options.

pub async fn logout(&self, return_to: Option<Location>)

Log the user out. If a return URL is provided, the user will be redirected to that URL after logging out.

Trait Implementations

impl Clone for AuthClient

fn clone(&self) -> AuthClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthClient

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

Formats the value using the given formatter.