getxfire
library
Classes
ActionCodeInfo
A response from calling checkActionCode.
ActionCodeSettings
Interface that defines the required continue/state URL with optional
Android and iOS bundle identifiers.
AdditionalUserInfo
A structure containing additional user information from a federated identity
provider.
AndroidUiSettings
A helper class provides properties that can be used to customize the cropper
view on Android.
AppleAuthCredential
The auth credential returned from calling
AppleAuthProvider.credential .
AppleAuthProvider
This class should be used to either create a new Apple credential with an
access code, or use the provider to trigger user authentication flows.
Auth
AuthCredential
Interface that represents the credentials returned by an auth provider.
Implementations specify the details about each auth provider's credential
requirements.
Bindings
Bindings should be extended or implemented.
When using GetMaterialApp, all GetPages and navigation
methods (like Get.to()) have a binding property that takes an
instance of Bindings to manage the
dependencies() (via Get.put()) for the Route you are opening.
BindingsBuilder <T >
Simplifies Bindings generation from a single callback.
To avoid the creation of a custom Binding instance per route.
Blob
Represents binary data stored in Uint8List .
ClassicGeneralDialogWidget
created time: 2019-07-31 09:35
author linzhiliang
version 1.0
since
file name: classic_dialog_widget.dart
description: General dialog
ClassicListDialogWidget <T >
created time: 2019-08-01 08:59
author linzhiliang
version 1.0
since
file name: classic_dialog_widget.dart
description: Classic dialog with list content
ClassicListDialogWidgetState <T >
CollectionReference <T extends Object ? >
ConfirmationResult
A result from a phone number sign-in, link, or reauthenticate call.
ConfirmDialog
ConverterHelper
CropAspectRatio
CustomDialog
A material design dialog.
CustomDialogWidget
created time: 2019-07-19 14:35
author linzhiliang
version 1.0
since
file name: animated_dialog.dart
description: Custom dialog widget
CustomTransition
DisposableInterface
DocumentChange <T extends Object ? >
A DocumentChange represents a change to the documents matching a query.
DocumentReference <T extends Object ? >
A DocumentReference refers to a document location in a FirebaseFirestore database
and can be used to write, read, or listen to the location.
DocumentSnapshot <T extends Object ? >
A DocumentSnapshot contains data read from a document in your FirebaseFirestore
database.
DottedScaleXWidget
DownloadTask
A class which indicates an on-going download task.
EmailAuthCredential
The auth credential returned from calling
EmailAuthProvider.credential .
EmailAuthProvider
A EmailAuthCredential can be created by calling
EmailAuthProvider.credential with an email and password.
ExButton
FacebookAuthCredential
The auth credential returned from calling
FacebookAuthProvider.credential .
FacebookAuthProvider
This class should be used to either create a new Facebook credential with an
access code, or use the provider to trigger user authentication flows.
FaIcon
Creates an Icon Widget that works for non-material Icons, such as the
Font Awesome Icons.
FastList <T >
FieldPath
A FieldPath refers to a field in a document.
FieldValue
Sentinel values that can be used when writing document fields with set() or
update().
FileModel
Firebase
The entry point for accessing Firebase.
FirebaseApp
Represents a single Firebase app instance.
FirebaseAuth
The entry point of the Firebase Authentication SDK.
FirebaseFirestore
The entry point for accessing a FirebaseFirestore .
FirebaseOptions
The options used to configure a Firebase app.
FirebaseStorage
The entrypoint for FirebaseStorage .
FirestoreService
FontAwesomeIcons
Icons based on font awesome 5.15.4
FormData
FullLifeCycleController
FullMetadata
The result of calling getMetadata on a storage object reference.
GeoPoint
Represents a geographical point by its longitude and latitude
GetBar
GetBuilder <T extends GetxController >
GetBuilderState <T extends GetxController >
GetConnect
GetConnectInterface
GetCupertinoApp
GetDelegate
GetHttpClient
GetInformationParser
GetInstance
GetInterface
GetInterface allows any auxiliary package to be merged into the "Get"
class through extensions
GetLifeCycle
GetMaterialApp
GetMaterialController
GetMicrotask
GetMiddleware
The Page Middlewares.
The Functions will be called in this order
(( redirect -> onPageCalled -> onBindingsStart ->
onPageBuildStart -> onPageBuilt -> onPageDispose ))
GetModalBottomSheetRoute <T >
GetNavConfig
This config enables us to navigate directly to a sub-url
GetNavigator
GetNotifier <T >
GetObserver
GetOptions
An options class that configures the behavior of get() calls on DocumentReference and Query .
GetPage <T >
GetPlatform
GetQueue
GetResponsiveView <T >
Extend this widget to build responsive view.
this widget contains the screen property that have all
information about the screen size and type.
You have two options to build it.
1- with builder method you return the widget to build.
2- with methods desktop, tablet,phone, watch. the specific
method will be built when the screen type matches the method
when the screen is ScreenType.Tablet the tablet method
will be exuded and so on.
Note if you use this method please set the
property alwaysUseBuilder to false
With settings property you can set the width limit for the screen types.
GetResponsiveWidget <T extends GetLifeCycleBase ? >
GetRouterOutlet
GetSnackBar
GetSnackBarState
GetSocket
GetStream <T >
GetStream is the lightest and most performative way of working
with events at Dart. You sintaxe is like StreamController, but it works
with simple callbacks. In this way, every event calls only one function.
There is no buffering, to very low memory consumption.
event add will add a object to stream. addError will add a error
to stream. listen is a very light StreamSubscription interface.
Is possible take the last value with value property.
GetStreamTransformation <T >
GetUtils
GetView <T >
GetView is a great way of quickly access your Controller
without having to call Get.find
GetWidget <S extends GetLifeCycleBase ? >
GetWidget is a great way of quickly access your individual Controller
without having to call Get.find
GetX <T extends DisposableInterface >
GetxController
GetxFire
GetxFire
GetxService
Unlike GetxController, which serves to control events on each of its pages,
GetxService is not automatically disposed (nor can be removed with
Get.delete()).
It is ideal for situations where, once started, that service will
remain in memory, such as Auth control for example. Only way to remove
it is Get.reset().
GetXState <T extends DisposableInterface >
GithubAuthCredential
The auth credential returned from calling
GithubAuthProvider.credential .
GithubAuthProvider
This class should be used to either create a new GitHub credential with an
access code, or use the provider to trigger user authentication flows.
GoogleAuthCredential
The auth credential returned from calling
GoogleAuthProvider.credential .
GoogleAuthProvider
This class should be used to either create a new Google credential with an
access code, or use the provider to trigger user authentication flows.
GraphQLResponse <T >
Helper
IconDataBrands
IconData for a font awesome brand icon from a code point
IconDataDuotone
IconData for a font awesome duotone icon from a code point. Only works if
duotone icons (font awesome pro) have been installed.
IconDataLight
IconData for a font awesome light icon from a code point. Only works if
light icons (font awesome pro) have been installed.
IconDataRegular
IconData for a font awesome regular icon from a code point
IconDataSolid
IconData for a font awesome solid icon from a code point
IconDataThin
IconData for a font awesome thin icon from a code point. Only works if
thin icons (font awesome pro, v6+) have been installed.
IdTokenResult
Interface representing ID token result obtained from getIdTokenResult.
It contains the ID token JWT string and other helper properties for getting
different data associated with the token as well as all the decoded payload
claims.
ImageCropper
A convenient class wraps all api functions of ImageCropper plugin
ImagePicker
Provides an easy way to pick an image/video from the image library,
or to take a picture/video with the camera.
InfoDialog
InstanceInfo
InternalFinalCallback <T >
Special callable class to keep the contract of a regular method, and avoid
overrides if you extend the class that uses it, as Dart has no final
methods.
Used in DisposableInterface to avoid the danger of overriding onStart.
IOSUiSettings
A helper class provides properties that can be used to customize the cropper
view on iOS.
LightSubscription <T >
ListEquality <E >
Equality on lists.
ListOptions
The options FirebaseStoragePlatform.list accepts.
ListResult
Class returned as a result of calling a list method (list or listAll)
on a Reference .
LoadBundleTask
LoadBundleTaskSnapshot
A LoadBundleTaskSnapshot is returned as the result or on-going process of a LoadBundleTask .
LostData
The response object of ImagePicker.retrieveLostData .
LostDataResponse
The response object of ImagePicker.getLostData .
LottiePath
MicrosoftAuthCredential
The auth credential returned from calling
MicrosoftAuthProvider.credential .
MicrosoftAuthProvider
This class should be used to either create a new Microsoft credential with an
access code, or use the provider to trigger user authentication flows.
MiddlewareRunner
MiniStream <T >
MiniSubscription <T >
MixinBuilder <T extends GetxController >
MultiFactor
Defines multi-factor related properties and operations pertaining to a User .
This class acts as the main entry point for enrolling or un-enrolling
second factors for a user, and provides access to their currently enrolled factors.
MultiFactorAssertion
Represents an assertion that the Firebase Authentication server
can use to authenticate a user as part of a multi-factor flow.
MultiFactorInfo
Represents a single second factor means for the user.
MultiFactorResolver
Utility class that contains methods to resolve second factor
requirements on users that have opted into two-factor authentication.
MultiFactorSession
Identifies the current session to enroll a second factor or to complete sign in when previously enrolled.
MultipartFile
Node <T >
OAuthCredential
A generic OAuth credential.
OAuthProvider
A generic provider instance.
Obx
The simplest reactive widget in GetX.
ObxState
ObxValue <T extends RxInterface >
Similar to Obx, but manages a local state.
Pass the initial data in constructor.
Useful for simple local states, like toggles, visibility, themes,
button states, etc.
Sample:
ObxValue((data) => Switch(
value: data.value,
onChanged: (flag) => data.value = flag,
),
false.obs,
),
ObxWidget
The ObxWidget is the base for all GetX reactive widgets
OpenDialog
PathDecoded
PersistenceSettings
A settings class that can be passed to Firestore.enablePersistence() to configure Firestore persistence.
Only supported for Web.
PhoneAuthCredential
The auth credential returned from calling
PhoneAuthProvider.credential .
PhoneAuthProvider
This class should be used to either create a new Phone credential with an
verification ID and SMS code.
PhoneMultiFactorGenerator
Provider for generating a PhoneMultiFactorAssertion.
PhoneMultiFactorInfo
Represents the information for a phone second factor.
PickedFile
A PickedFile is a cross-platform, simplified File abstraction.
ProgressHud
Query <T extends Object ? >
Represents a Query over the data at a particular location.
QueryDocumentSnapshot <T extends Object ? >
A QueryDocumentSnapshot contains data read from a document in your FirebaseFirestore
database as part of a query.
QuerySnapshot <T extends Object ? >
Contains the results of a query.
It can contain zero or more DocumentSnapshot objects.
RecaptchaVerifier
An reCAPTCHA -based
application verifier.
Reference
Represents a reference to a Google Cloud Storage object. Developers can
upload, download, and delete objects, as well as get/set object metadata.
Response <T >
ResponsiveScreen
ResponsiveScreenSettings
RingPainter
RouterOutlet <TDelegate extends RouterDelegate <T > , T extends Object >
RouterOutletState <TDelegate extends RouterDelegate <T > , T extends Object >
Routing
Rx <T >
Foundation class used for custom Types outside the common native Dart
types.
For example, any custom "Model" class, like User().obs will use Rx as
wrapper.
RxBool
RxController
RxDouble
RxInt
RxInterface <T >
This class is the foundation for all reactive (Rx) classes that makes Get
so powerful.
This interface is the contract that _RxImpl]
RxList <E >
Create a list similar to List<T>
RxMap <K , V >
Rxn <T >
RxnBool
RxnDouble
RxnInt
RxnNum
RxNotifier <T >
RxnString
Rx class for String Type.
RxNum
RxSet <E >
RxStatus
RxString
Rx class for String Type.
SAMLAuthProvider
Security Assertion Markup Language based provider.
ScaleYWidget
SetOptions
An options class that configures the behavior of set() calls in DocumentReference ,
WriteBatch and Transaction .
SettableMetadata
The settable metadata a storage object reference can be set with.
Settings
Specifies custom configurations for your Cloud Firestore instance.
SimpleBuilder
SimpleBuilderState
SnackbarController
SnapshotMetadata
Metadata about a snapshot, describing the state of the snapshot.
SnapshotOptions
Options that configure how data is retrieved from a DocumentSnapshot
(e.g. the desired behavior for server timestamps that have not yet been set to their final value).
SpinKitChasingDots
SpinKitCircle
SpinKitCubeGrid
SpinKitDancingSquare
SpinKitDoubleBounce
SpinKitDualRing
SpinKitFadingCircle
SpinKitFadingCube
SpinKitFadingFour
SpinKitFadingGrid
SpinKitFoldingCube
SpinKitHourGlass
SpinKitPianoWave
SpinKitPouringHourGlass
SpinKitPouringHourGlassRefined
SpinKitPulse
SpinKitPulsingGrid
SpinKitPumpCurve
SpinKitPumpingHeart
SpinKitRing
SpinKitRingCurve
SpinKitRipple
SpinKitRotatingCircle
SpinKitRotatingPlain
SpinKitSpinningCircle
SpinKitSpinningLines
SpinKitSquareCircle
SpinKitThreeBounce
SpinKitThreeInOut
SpinKitWanderingCubes
SpinKitWave
SpinkitWaveCustomPaint
SpinKitWaveSpinner
SpinningLinesPainter
StorageService
SuperController <T >
Task
A class representing an on-going storage task that additionally delegates to a Future .
TaskSnapshot
A TaskSnapshot is returned as the result or on-going process of a Task .
Timestamp
A Timestamp represents a point in time independent of any time zone or calendar,
represented as seconds and fractions of seconds at nanosecond resolution in UTC
Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends
the Gregorian calendar backwards to year one. It is encoded assuming all minutes
are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table
is needed for interpretation. Range is from 0001-01-01T00:00:00Z to
9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we
can convert to and from RFC 3339 date strings.
Transaction
Transaction class which is created from a call to runTransaction().
Translations
TrustedCertificate
The auth credential returned from calling
TwitterAuthProvider.credential .
This class should be used to either create a new Twitter credential with an
access code, or use the provider to trigger user authentication flows.
UploadTask
A class which indicates an on-going upload task.
User
A user account.
UserCredential
A UserCredential is returned from authentication requests such as
createUserWithEmailAndPassword.
UserInfo
User profile information, visible only to the Firebase project's apps.
UserMetadata
Interface representing a user's metadata.
Value <T >
ValueBuilder <T >
Manages a local state like ObxValue, but uses a callback instead of
a Rx value.
ValueBuilderState <T >
Worker
Workers
WriteBatch
A WriteBatch is a series of write operations to be performed as one unit.
XFile
A CrossFile is a cross-platform, simplified File abstraction.
YahooAuthCredential
The auth credential returned from calling
YahooAuthProvider.credential .
YahooAuthProvider
This class should be used to either create a new Yahoo credential with an
access code, or use the provider to trigger user authentication flows.
Enums
ActionCodeInfoOperation
The type of operation that generated the action code from calling
checkActionCode.
CameraDevice
Which camera to use when picking images/videos while source is ImageSource.camera.
CropAspectRatioPreset
A set of preset values can be used to setup the menu of crop aspect ratio
options in the cropper view.
CropStyle
Crop style options. There're two supported styles, rectangle and circle.
These style will changes the shape of crop bounds, rectangle or circle bounds.
DialogTransitionType
DocumentChangeType
An enumeration of document change types.
ImageCompressFormat
Supported image compression formats
ImageSource
Specifies the source where the picked image should come from.
ListType
List type
Persistence
An enumeration of the possible persistence mechanism types.
PopMode
Enables the user to customize the intended pop behavior
PreventDuplicateHandlingMode
Enables the user to customize the behavior when pushing multiple routes that
shouldn't be duplicates
PutStringFormat
The format in which a string can be uploaded to the storage bucket via
Reference.putString .
RecaptchaVerifierSize
A enum to represent a reCAPTCHA widget size.
RecaptchaVerifierTheme
A enum to represent a reCAPTCHA widget theme.
RetrieveType
The type of the retrieved data in a LostDataResponse .
RowStyle
ScreenType
SmartManagement
GetX by default disposes unused controllers from memory,
Through different behaviors.
SmartManagement.full
SmartManagement.full is the default one. Dispose classes that are
not being used and were not set to be permanent. In the majority
of the cases you will want to keep this config untouched.
If you new to GetX then don't change this.
SmartManagement.onlyBuilder only controllers started in init:
or loaded into a Binding with Get.lazyPut() will be disposed. If you use
Get.put() or Get.putAsync() or any other approach, SmartManagement
will not have permissions to exclude this dependency. With the default
behavior, even widgets instantiated with "Get.put" will be removed,
unlike SmartManagement.onlyBuilders.
SmartManagement.keepFactory Just like SmartManagement.full,
it will remove it's dependencies when it's not being used anymore.
However, it will keep their factory, which means it will recreate
the dependency if you need that instance again.
SnackbarStatus
Indicates Status of snackbar
SnackbarStatus.OPEN Snack is fully open, SnackbarStatus.CLOSED Snackbar
has closed,
SnackbarStatus.OPENING Starts with the opening animation and ends
with the full
snackbar display, SnackbarStatus.CLOSING Starts with the closing animation
and ends
with the full snackbar dispose
SnackPosition
Indicates if snack is going to start at the TOP or at the BOTTOM
SnackStyle
Indicates if snack will be attached to the edge of the screen or not
Source
An enumeration of firestore source types.
SpinKitPianoWaveType
SpinKitWaveType
TaskState
Represents the state of an on-going Task .
Transition
Properties
Get → _GetImpl
final
isShowing ↔ bool
Is dialog showing
getter/setter pair
navigator → NavigatorState ?
It replaces the Flutter Navigator, but needs no context.
You can to use navigator.push(YourRoute()) rather
Navigator.push(context, YourRoute());
no setter
Functions
ambiguate <T > (T? value → T?
aspectRatioPresetName (CropAspectRatioPreset ?preset → String
bodyBytesToString (Stream <List <int bodyBytes , Map <String String headers → Future <String
compressFormatName (ImageCompressFormat format → String
cropStyleName (CropStyle style → String
debounce <T > (RxInterface <T > listener , WorkerCallback <T > callback , {Duration ?time , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
debounce is similar to interval , but sends the last value.
Useful for Anti DDos, every time the user stops typing for 1 second,
for instance.
When listener emits the last "value", when time hits,
it calls callback with the last "value" emitted.
defaultLogWriterCallback (String value , {bool isError = false → void
default logger from GetX
ever <T > (RxInterface <T > listener , WorkerCallback <T > callback , {dynamic condition = true , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
Called every time listener changes. As long as the condition
returns true.
everAll (List <RxInterface listeners , WorkerCallback callback , {dynamic condition = true , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
Similar to ever , but takes a list of listeners, the condition
for the callback is common to all listeners,
and the callback is executed to each one of them. The Worker is
common to all, so worker.dispose() will cancel all streams.
interval <T > (RxInterface <T > listener , WorkerCallback <T > callback , {Duration time = const Duration(seconds: 1) , dynamic condition = true , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
Ignore all changes in listener during time (1 sec by default) or until
condition is met (can be a bool expression or a bool Function()),
It brings the 1st "value" since the period of time, so
if you click a counter button 3 times in 1 sec, it will show you "1"
(after 1 sec of the first press)
click counter 3 times in 1 sec, it will show you "4" (after 1 sec)
click counter 2 times in 1 sec, it will show you "7" (after 1 sec).
once <T > (RxInterface <T > listener , WorkerCallback <T > callback , {dynamic condition = true , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
once() will execute only 1 time when condition is met and cancel
the subscription to the listener stream right after that.
condition defines when callback is called, and
can be a bool or a bool Function().
showAnimatedDialog <T extends Object ? > ({required BuildContext context , bool barrierDismissible = false , required WidgetBuilder builder , dynamic animationType = DialogTransitionType.size , Curve curve = Curves.linear , Duration ?duration , Alignment alignment = Alignment.center , Color ?barrierColor , Axis ?axis = Axis.horizontal → Future <T? >
Displays a Material dialog above the current contents of the app
Typedefs
AddSubscription T >
= FutureOr <void > Function(LightSubscription <T > subs
AsyncInstanceBuilderCallback S >
= Future <S > Function()
BindingBuilderCallback
= void Function()
Condition
= bool Function()
Decoder T >
= T Function(dynamic data
FromFirestore T >
= T Function(DocumentSnapshot <Map <String dynamic > snapshot , SnapshotOptions ?options
GetControllerBuilder T extends DisposableInterface >
= Widget Function(T controller
GetPageBuilder
= Widget Function()
GetXControllerBuilder T extends DisposableInterface >
= Widget Function(T controller
InjectorBuilderCallback S >
= S Function(GetInstance
InstanceBuilderCallback S >
= S Function()
LogWriterCallback
= void Function(String text , {bool isError
VoidCallback from logs
NotifierBuilder T >
= Widget Function(T state
OnMultiSelectionCallback
= void Function(List <int selectedIndexes
Multiple selection callback of list dialog
OnSingleSelectionCallback
= void Function(int selectedIndex
Single selection callback of list dialog
OnTap
= void Function(GetSnackBar snack
PhoneCodeAutoRetrievalTimeout
= void Function(String verificationId
Typedef for handling automatic phone number timeout resolution.
PhoneCodeSent
= void Function(String verificationId , int ?forceResendingToken
Typedef for handling when Firebase sends a SMS code to the provided phone
number.
PhoneVerificationCompleted
= void Function(PhoneAuthCredential phoneAuthCredential
Typedef for a automatic phone number resolution.
PhoneVerificationFailed
= void Function(FirebaseAuthException error
Typedef for handling errors via phone number verification.
PrintFunctionCallback
= void Function(String prefix , dynamic value , String info , {bool ?isError
Progress
= dynamic Function(double percent
RecaptchaVerifierOnError
= void Function(FirebaseAuthException exception
Called when the reCAPTCHA widget errors (such as a network error).
RecaptchaVerifierOnExpired
= void Function()
Called when the time to complete the reCAPTCHA widget expires.
RecaptchaVerifierOnSuccess
= void Function()
Called on successful completion of the reCAPTCHA widget.
RemoveSubscription T >
= FutureOr <bool ? Function(LightSubscription <T > subs
SnackbarStatusCallback
= void Function(SnackbarStatus ?status
ToFirestore T >
= Map <String Object ? Function(T value , SetOptions ?options
TransactionHandler T >
= Future <T > Function(Transaction transaction
The TransactionHandler may be executed multiple times; it should be able
to handle multiple executions.
ValueBuilderBuilder T >
= Widget Function(T snapshot , ValueBuilderUpdateCallback <T > updater
ValueBuilderUpdateCallback T >
= void Function(T snapshot
ValueUpdater T >
= T Function()
WidgetCallback
= Widget Function()
WorkerCallback T >
= dynamic Function(T callback
Exceptions / Errors
FirebaseAuthException
Generic exception related to Firebase Authentication. Check the error code
and message for more details.
FirebaseAuthMultiFactorException
MultiFactor exception related to Firebase Authentication. Check the error code
and message for more details.
FirebaseException
A generic class which provides exceptions in a Firebase-friendly format
to users.
