WatchQueryOptions<TParsed extends Object?> class
- Inheritance
-
- Object
- QueryOptions<
TParsed> - WatchQueryOptions
- Annotations
Constructors
-
WatchQueryOptions.new({required DocumentNode document, String? operationName, Map<
String, dynamic> variables = const {}, FetchPolicy? fetchPolicy, ErrorPolicy? errorPolicy, CacheRereadPolicy? cacheRereadPolicy, Object? optimisticResult, Duration? pollInterval, bool fetchResults = false, bool carryForwardDataOnException = true, bool? eagerlyFetchResults, Context? context, ResultParserFn<TParsed> ? parserFn, Duration? queryRequestTimeout})
Properties
- asRequest → Request
-
Resolve these options into a request
no setterinherited
- cacheRereadPolicy → CacheRereadPolicy?
-
no setterinherited
- carryForwardDataOnException → bool
-
carry forward previous data in the result of errors and no data.
defaults to
true
.final - context → Context
-
Context to be passed to link execution chain.
finalinherited
- document → DocumentNode
-
Document containing at least one
OperationDefinitionNode
finalinherited - eagerlyFetchResults → bool
-
Whether to fetchResults immediately on instantiation of ObservableQuery.
If available, cache results are emitted when the first listener is added.
Network results are then emitted when they return to any attached listeners.
Defaults to fetchResults.
final
- errorPolicy → ErrorPolicy?
-
no setterinherited
- fetchPolicy → FetchPolicy?
-
no setterinherited
- fetchResults → bool
-
Whether or not to fetch results every time a new listener is added.
If eagerlyFetchResults is
true
, fetch is triggered during instantiation.final - hashCode → int
-
The hash code for this object.
no setterinherited
- isMutation → bool
-
no setterinherited
- isQuery → bool
-
no setterinherited
- isSubscription → bool
-
no setterinherited
- onComplete → OnQueryComplete?
-
finalinherited
- onError → OnQueryError?
-
finalinherited
- operationName → String?
-
Name of the executable definition
finalinherited
- optimisticResult → Object?
-
An optimistic result to eagerly add to the operation stream
finalinherited
-
parserFn
→ ResultParserFn<
TParsed> -
finalinherited
- policies → Policies
-
Specifies the Policies to be used during execution.
finalinherited
- pollInterval → Duration?
-
The time interval on which this query should be re-fetched from the server.
finalinherited
-
properties
→ List<
Object?> -
no setteroverride
- queryRequestTimeout → Duration?
-
Override default query timeout
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → OperationType
-
no setterinherited
-
variables
→ Map<
String, dynamic> -
A map going from variable name to variable value, where the variables are used
within the GraphQL query.
finalinherited
Methods
-
asWatchQueryOptions(
{bool fetchResults = true}) → WatchQueryOptions< TParsed> -
inherited
-
copyWith(
{DocumentNode? document, String? operationName, Map< String, dynamic> ? variables, FetchPolicy? fetchPolicy, ErrorPolicy? errorPolicy, CacheRereadPolicy? cacheRereadPolicy, Object? optimisticResult, Duration? pollInterval, bool? fetchResults, bool? carryForwardDataOnException, bool? eagerlyFetchResults, Context? context, ResultParserFn<TParsed> ? parserFn, Duration? queryRequestTimeout}) → WatchQueryOptions<TParsed> - Generic copyWith for all fields. There are other, more specific options:
-
copyWithFetchPolicy(
FetchPolicy? fetchPolicy) → WatchQueryOptions< TParsed> -
copyWithOptimisticResult(
Object? optimisticResult) → WatchQueryOptions< TParsed> -
copyWithOptions(
{DocumentNode? document, String? operationName, Map< String, dynamic> ? variables, FetchPolicy? fetchPolicy, ErrorPolicy? errorPolicy, CacheRereadPolicy? cacheRereadPolicy, Object? optimisticResult, Duration? pollInterval, Context? context, ResultParserFn<TParsed> ? parserFn, Duration? queryRequestTimeout, OnQueryComplete? onComplete, OnQueryError? onError}) → QueryOptions<TParsed> -
Generic copyWith for all fields. There are other, more specific options:
inherited
-
copyWithPolicies(
Policies policies) → WatchQueryOptions< TParsed> -
override
-
copyWithPollInterval(
Duration? pollInterval) → WatchQueryOptions< TParsed> -
copyWithVariables(
Map< String, dynamic> variables) → WatchQueryOptions<TParsed> -
createResult(
{Map< String, dynamic> ? data, OperationException? exception, Context context = const Context(), required QueryResultSource source}) → QueryResult<TParsed> -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
withFetchMoreOptions(
FetchMoreOptions fetchMoreOptions) → QueryOptions< TParsed> -
inherited
Operators
-
operator ==(
Object other) → bool -
properties
based deep equality checkinherited