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 StatefulWidget

Signs 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.

ParameterTypeKindDefault
ovokOvokrequired named
profileTypeProfileTyperequired named
translationsAuthTranslationsnameddefaultAuthTranslations
googleInternalIdString?named
googleClientIdString?named
googleServerClientIdString?named
onSuccessFuture<void> Function(Session)?named
onRegisterVoidCallback?named
onResetPasswordVoidCallback?named
onErrorvoid Function(Object)?named
keyKey?named

Properties

SignIn.ovok

final Ovok ovok

The client used for authentication requests.

SignIn.profileType

final ProfileType profileType

The account profile type to sign in as.

SignIn.translations

final AuthTranslations translations

Labels to use for this form.

SignIn.googleInternalId

final String? googleInternalId

Enables Google sign-in when set; used as the Ovok social-login identifier.

SignIn.googleClientId

final String? googleClientId

Overrides the native Google client ID or web meta-tag value.

SignIn.googleServerClientId

final String? googleServerClientId

The native server client ID used to request an ID token.

SignIn.onSuccess

final Future<void> Function(Session)? onSuccess

Called after the client stores a signed-in session.

SignIn.onRegister

final VoidCallback? onRegister

Called when the user chooses to register.

SignIn.onResetPassword

final VoidCallback? onResetPassword

Called when the user chooses to reset their password.

SignIn.onError

final void Function(Object)? onError

Called when an authentication request fails.

Last updated on

On this page