inqvine_core_firebase 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.
AggregateField
AggregateQuery
AggregateQuery represents the data at a particular location for retrieving metadata without retrieving the actual documents.
AggregateQuerySnapshot
AggregateQuerySnapshot represents a response to an AggregateQuery request.
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.
ApplicationStatus
AuthCredential
Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.
AuthProvider
A base class which all providers must extend.
average
Create an object that can be used to compute the average of a specified field over a range of documents in the result set of a query.
Blob
Represents binary data stored in Uint8List.
CollectionReference<T extends Object?>
ConfirmationResult
A result from a phone number sign-in, link, or reauthenticate call.
count
Create a CountAggregateField object that can be used to compute the count of documents in the result set of a query.
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.
EmailAuthCredential
The auth credential returned from calling EmailAuthProvider.credential.
EmailAuthProvider
A EmailAuthCredential can be created by calling EmailAuthProvider.credential with an email and password.
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.
FieldOverrideIndex
FieldOverrides
The FieldOverrides class follows the FieldOverrides definition.
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().
Filter
A Filter represents a restriction on one or more field values and can be used to refine the results of a Query.
FirebaseAuth
The entry point of the Firebase Authentication SDK.
FirebaseFirestore
The entry point for accessing a FirebaseFirestore.
GameCenterAuthCredential
The auth credential returned from calling GameCenterAuthProvider.credential.
GameCenterAuthProvider
This class should be used to create a new Game Center credential to trigger an authentication flow on Apple platform.
GeoPoint
Represents a geographical point by its longitude and latitude
GetOptions
An options class that configures the behavior of get() calls on DocumentReference and Query.
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.
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.
Index
The Index class follows the Index definition.
IndexField
InqvineAdminService
InqvineAuthService
Common authentication methods used by Firebase.
InqvineCoreFirebase
InqvineSystemService
ListEquality<E>
Equality on lists.
LoadBundleTask
LoadBundleTaskSnapshot
A LoadBundleTaskSnapshot is returned as the result or on-going process of a LoadBundleTask.
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.
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.
OAuthCredential
A generic OAuth credential.
OAuthProvider
A generic provider instance.
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.
PlayGamesAuthCredential
The auth credential returned from calling PlayGamesAuthProvider.credential.
PlayGamesAuthProvider
This class should be used to either create a new Play Games credential with an access code, or use the provider to trigger user authentication flows.
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.
SAMLAuthProvider
Security Assertion Markup Language based provider.
SetOptions
An options class that configures the behavior of set() calls in DocumentReference, WriteBatch and Transaction.
Settings
Specifies custom configurations for your Cloud Firestore instance.
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).
sum
Create an object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.
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.
TotpMultiFactorGenerator
Provider for generating a PhoneMultiFactorAssertion.
TotpMultiFactorInfo
Represents the information for a phone second factor.
TotpSecret
Transaction
Transaction class which is created from a call to runTransaction().
TwitterAuthCredential
The auth credential returned from calling TwitterAuthProvider.credential.
TwitterAuthProvider
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.
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.
WriteBatch
A WriteBatch is a series of write operations to be performed as one unit.
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.
AggregateSource
AggregateSource represents the source of data for an AggregateQuery.
ArrayConfig
DocumentChangeType
An enumeration of document change types.
ListenSource
The listener retrieves data and listens to updates from the local Firestore cache only. If the cache is empty, an empty snapshot will be returned. Snapshot events will be triggered on cache updates, like local mutations or load bundles.
LoadBundleTaskState
Represents the state of an on-going LoadBundleTask.
Order
Persistence
An enumeration of the possible persistence mechanism types.
QueryScope
RecaptchaVerifierSize
A enum to represent a reCAPTCHA widget size.
RecaptchaVerifierTheme
A enum to represent a reCAPTCHA widget theme.
ServerTimestampBehavior
Source
An enumeration of firestore source types.

Properties

applicationStatusDescriptor → Uint8List
Descriptor for ApplicationStatus. Decode as a google.protobuf.DescriptorProto.
final
inqvineFirebase → InqvineCoreFirebase
no setter

Typedefs

FromFirestore<T> = T Function(DocumentSnapshot<Map<String, dynamic>> snapshot, SnapshotOptions? options)
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.
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.
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.

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.