Struct dittolive_ditto::auth::authenticator::DittoAuthenticator

pub struct DittoAuthenticator { /* private fields */ }

Handle to trigger authentication requests

Implementations

impl DittoAuthenticator

pub fn new() -> Self

pub fn login_with_token_and_feedback(
    &self,
    token: &str,
    provider: &str
) -> Result<AuthenticationClientFeedback, DittoError>

Asks the Ditto instance to make an auth request to the configured Identity’s auth URL with a single token parameter.

• token: An auth or API token you have configured.
• provider: The name of an authentication provider web hook you have configured in Ditto. Cloud, which will accept the token and contact your Auth service

pub fn logout<R>(
    &self,
    cleanup: impl FnOnce(Ditto) -> R
) -> Result<R, DittoError>

Log out of Ditto.

Shutdown all replication sessions and remove any cached authentication credentials. This does not remove the local data store.

pub fn is_authenticated(&self) -> bool

Query whether Ditto has a valid authentication token.

This will only be true when using an OnlineWithAuthentication identity, after a successful login. If the authentication token is allowed to expire then it will return false instead.

pub fn user_id(&self) -> Option<String>

The currently logged-in user ID.

This will return None if there is no valid authentication or an OnlineWithAuthentication identity is not being used.

Trait Implementations

impl Clone for DittoAuthenticator

fn clone(&self) -> DittoAuthenticator

Returns a copy of the value.

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

Performs copy-assignment from source.