Sign in
Generated reference for ovok_flutter: sign in.
- Stable unknown
- Release candidate since 0.1.0-rc.4
- Development since 0.1.0-dev.25+148a28a
SignIn
class SignIn extends StatefulWidgetSigns in with a password or Google and handles second-factor challenges.
Constructors
SignIn.new
SignIn({
required Ovok ovok,
required ProfileType profileType,
AuthTranslations translations = defaultAuthTranslations,
String? googleInternalId,
String? googleClientId,
String? googleServerClientId,
Future<void> Function(Session)? onSuccess,
VoidCallback? onRegister,
VoidCallback? onResetPassword,
void Function(Object)? onError,
Key? key,
})Creates a sign-in form for profileType.
| Parameter | Type | Kind | Default |
|---|---|---|---|
ovok | Ovok | required named | |
profileType | ProfileType | required named | |
translations | AuthTranslations | named | defaultAuthTranslations |
googleInternalId | String? | named | |
googleClientId | String? | named | |
googleServerClientId | String? | named | |
onSuccess | Future<void> Function(Session)? | named | |
onRegister | VoidCallback? | named | |
onResetPassword | VoidCallback? | named | |
onError | void Function(Object)? | named | |
key | Key? | named |
Properties
SignIn.ovok
final Ovok ovokThe client used for authentication requests.
SignIn.profileType
final ProfileType profileTypeThe account profile type to sign in as.
SignIn.translations
final AuthTranslations translationsLabels to use for this form.
SignIn.googleInternalId
final String? googleInternalIdEnables Google sign-in when set; used as the Ovok social-login identifier.
SignIn.googleClientId
final String? googleClientIdOverrides the native Google client ID or web meta-tag value.
SignIn.googleServerClientId
final String? googleServerClientIdThe native server client ID used to request an ID token.
SignIn.onSuccess
final Future<void> Function(Session)? onSuccessCalled after the client stores a signed-in session.
SignIn.onRegister
final VoidCallback? onRegisterCalled when the user chooses to register.
SignIn.onResetPassword
final VoidCallback? onResetPasswordCalled when the user chooses to reset their password.
SignIn.onError
final void Function(Object)? onErrorCalled when an authentication request fails.
Last updated on