GetOptions class
An options class that configures the behavior of get() calls on DocumentReference and Query.
By providing a GetOptions object, these methods can be configured to fetch results only from the server, only from the local cache or attempt to fetch results from the server and fall back to the cache (which is the default).
Constructors
- GetOptions({Source source = Source.serverAndCache, ServerTimestampBehavior serverTimestampBehavior = ServerTimestampBehavior.none})
-
Creates a GetOptions instance.
const
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverTimestampBehavior → ServerTimestampBehavior
-
If set, controls the return value for server timestamps that have not yet been set to their final value.
final
- source → Source
-
Describes whether we should get from server or cache.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited