BgGeolocationController class Null safety
Background geolocation controller
- Inheritance
- Object
- GetLifeCycle
- DisposableInterface
- GetxController
- BgGeolocationController
Constructors
- BgGeolocationController({Config? config, bool debug = false})
- Bg Geolocation controller
Properties
- config → Config
-
Default geolocation configuration
final
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- hasListeners → bool
-
read-only, inherited
- initialized → bool
-
Checks whether the controller has already been initialized.
read-only, inherited
- isClosed → bool
-
Checks whether the controller has already been closed.
read-only, inherited
- listeners → int
-
read-only, inherited
- locationCount ↔ int
-
number of locations received in this session
read / write
-
locations
↔ RxList<
Location> -
First and last locations processed
read / write
-
onDelete
→ InternalFinalCallback<
void> -
Internal callback that starts the cycle of this controller.
final, inherited
-
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.
final, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- started → bool
-
Has location polling started
read-only
- stopwatch → Stopwatch
-
Stopwatch measuring elapsed time since location tracking started
final
Methods
-
$configureLifeCycle(
) → void -
inherited
-
addListener(
GetStateUpdate listener) → Disposer -
Register a closure to be called when the object notifies its listeners.
inherited
-
addListenerId(
Object? key, GetStateUpdate listener) → Disposer -
inherited
-
addLocation(
Location location) → dynamic - Update the current locations
-
destroyLocationUpdates(
) → Future< void> - Destroy the location updates previously received
-
dispose(
) → void -
@mustCallSuper, inherited
-
disposeId(
Object id) → void -
To dispose an
id
from future updates(), this ids are registered byGetBuilder()
or similar, so is a way to unlink the state change with the Widget from the Controller.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
notifyChildrens(
) → void -
@protected, 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.
@mustCallSuper, 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
-
refresh(
) → void -
@protected, inherited
-
refreshGroup(
Object id) → void -
@protected, inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that the
object notifies.
inherited
-
removeListenerId(
Object id, VoidCallback listener) → void -
inherited
-
startListening(
{String? runId, Config? trackingConfig}) → dynamic - Start listening to location updates
-
stopLocationUpdates(
) → Future< void> - Stop receiving location updates
-
toString(
) → String -
A string representation of this object. [...]
inherited
-
update(
[List< Object> ? ids, bool condition = true]) → void -
Rebuilds
GetBuilder
each time you callupdate()
; Can take a List ofids
, that will only update the matchingGetBuilder( id: )
,ids
can be reused amongGetBuilders
like group tags. The update will only notify the Widgets, ifcondition
is true.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited
Static Properties
- instance → BgGeolocationController
-
Current inserted instance
read-only
- maxLocations ↔ int
-
Maximum locations to save
read / write