LocaleService class

Manages the current language + persists the user's choice.

Inheritance
  • Object
  • GetLifeCycle
  • DisposableInterface
  • GetxService
  • LocaleService

Constructors

LocaleService(StorageService _store)

Properties

current → Rx<Locale>
final
hashCode → int
The hash code for this object.
no setterinherited
initialized → bool
Checks whether the controller has already been initialized.
no setterinherited
isClosed → bool
Checks whether the controller has already been closed.
no setterinherited
onDelete → InternalFinalCallback<void>
Internal callback that starts the cycle of this controller.
finalinherited
onStart → InternalFinalCallback<void>
Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclases. This method should be internal and is required to define the lifetime cycle of the subclass.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

$configureLifeCycle() → void
inherited
change(Locale locale) → Future<void>
Throws ArgumentError (BUG-26) for a locale not in AppTranslations.supported — accepting it anyway would run the CURRENT session untranslated (fallback text everywhere), then have _loadInitial reject that same persisted code on the next launch and silently revert, an inconsistent before/after-restart experience.
isCurrent(Locale l) → bool
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onClose() → void
Called before onDelete method. onClose might be used to dispose resources used by the controller. Like closing events, or streams before the controller is destroyed. Or dispose objects that can potentially create some memory leaks, like TextEditingControllers, AnimationControllers. Might be useful as well to persist some data on disk.
inherited
onInit() → void
Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
inherited
onReady() → void
Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

maybe → LocaleService?
Safe to call from a call site that may run before/without this service registered (e.g. widget tests), matching every other service in this codebase (AudioManager.maybe, CrashReporter.maybe, ...).
no setter