Enum ruma_client_api::uiaa::AuthData
source · [−]#[non_exhaustive]
pub enum AuthData<'a> {
Password(Password<'a>),
ReCaptcha(ReCaptcha<'a>),
EmailIdentity(EmailIdentity<'a>),
Msisdn(Msisdn<'a>),
Dummy(Dummy<'a>),
RegistrationToken(RegistrationToken<'a>),
FallbackAcknowledgement(FallbackAcknowledgement<'a>),
// some variants omitted
}
client
or server
only.Expand description
Information for one authentication stage.
To construct the custom AuthData
variant you first have to construct IncomingAuthData::new
and then call IncomingAuthData::to_outgoing
on it.
Variants (Non-exhaustive)
This enum is marked as non-exhaustive
Password(Password<'a>)
Password-based authentication (m.login.password
).
ReCaptcha(ReCaptcha<'a>)
Google ReCaptcha 2.0 authentication (m.login.recaptcha
).
EmailIdentity(EmailIdentity<'a>)
Email-based authentication (m.login.email.identity
).
Msisdn(Msisdn<'a>)
Phone number-based authentication (m.login.msisdn
).
Dummy(Dummy<'a>)
Dummy authentication (m.login.dummy
).
RegistrationToken(RegistrationToken<'a>)
Registration token-based authentication (m.login.registration_token
).
FallbackAcknowledgement(FallbackAcknowledgement<'a>)
Fallback acknowledgement.
Implementations
sourceimpl<'a> AuthData<'a>
impl<'a> AuthData<'a>
sourcepub fn fallback_acknowledgement(session: &'a str) -> Self
pub fn fallback_acknowledgement(session: &'a str) -> Self
Creates a new AuthData::FallbackAcknowledgement
with the given session key.
sourcepub fn data(&self) -> Cow<'_, JsonObject>
pub fn data(&self) -> Cow<'_, JsonObject>
Returns the associated data.
The returned JSON object won’t contain the type
and session
fields, use
.auth_type()
/ .session()
to access those.
Prefer to use the public variants of AuthData
where possible; this method is meant to be
used for custom auth types only.