com.apollographql.apollo

Interface ApolloQueryCall<T>

All Superinterfaces:

ApolloCall<T>, Cancelable

All Known Implementing Classes:

RealApolloCall

public interface ApolloQueryCall<T>
extends ApolloCall<T>

A call prepared to execute GraphQL query operation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ApolloQueryCall.Factory Factory for creating ApolloQueryCall calls.

Nested classes/interfaces inherited from interface com.apollographql.apollo.ApolloCall

ApolloCall.Callback<T>, ApolloCall.StatusEvent

Method Summary

Modifier and Type	Method and Description
ApolloQueryCall<T>	cacheHeaders(CacheHeaders cacheHeaders) Sets the CacheHeaders to use for this call.
ApolloQueryCall<T>	clone() Creates a new, identical call to this one which can be enqueued or executed even if this call has already been.
ApolloQueryCall<T>	httpCachePolicy(com.apollographql.apollo.api.cache.http.HttpCachePolicy.Policy httpCachePolicy) Sets the http cache policy for response/request cache.
ApolloQueryCall<T>	requestHeaders(RequestHeaders requestHeaders) Sets the RequestHeaders to use for this call.
ApolloQueryCall<T>	responseFetcher(ResponseFetcher fetcher) Sets the ResponseFetcher strategy for an ApolloCall object.
ApolloQueryWatcher<T>	watcher() Returns a watcher to watch the changes to the normalized cache records this query depends on or when mutation call triggers to re-fetch this query after it completes via ApolloMutationCall.refetchQueries(OperationName...)

Methods inherited from interface com.apollographql.apollo.ApolloCall

cancel, enqueue, operation

Methods inherited from interface com.apollographql.apollo.internal.util.Cancelable

isCanceled

Method Detail

watcher

@NotNull
ApolloQueryWatcher<T> watcher()

Returns a watcher to watch the changes to the normalized cache records this query depends on or when mutation call triggers to re-fetch this query after it completes via ApolloMutationCall.refetchQueries(OperationName...)

Returns:

ApolloQueryWatcher

httpCachePolicy

@NotNull
ApolloQueryCall<T> httpCachePolicy(@NotNull
                                            com.apollographql.apollo.api.cache.http.HttpCachePolicy.Policy httpCachePolicy)

Sets the http cache policy for response/request cache.

Parameters:

httpCachePolicy - HttpCachePolicy.Policy to set

Returns:

ApolloQueryCall with the provided HttpCachePolicy.Policy

cacheHeaders

@NotNull
ApolloQueryCall<T> cacheHeaders(@NotNull
                                         CacheHeaders cacheHeaders)

Sets the CacheHeaders to use for this call. com.apollographql.apollo.interceptor.FetchOptions will be configured with this headers, and will be accessible from the ResponseFetcher used for this call.

Specified by:

cacheHeaders in interface ApolloCall<T>

Parameters:

cacheHeaders - the CacheHeaders that will be passed with records generated from this request to NormalizedCache. Standardized cache headers are defined in ApolloCacheHeaders.

Returns:

The ApolloCall object with the provided CacheHeaders.

responseFetcher

@NotNull
ApolloQueryCall<T> responseFetcher(@NotNull
                                            ResponseFetcher fetcher)

Sets the ResponseFetcher strategy for an ApolloCall object.

Parameters:

fetcher - the ResponseFetcher to use.

Returns:

The ApolloCall object with the provided CacheControl strategy

requestHeaders

@NotNull
ApolloQueryCall<T> requestHeaders(@NotNull
                                           RequestHeaders requestHeaders)

Sets the RequestHeaders to use for this call. These headers will be added to the HTTP request when it is issued. These headers will be applied after any headers applied by application-level interceptors and will override those if necessary.

Parameters:

requestHeaders - The RequestHeaders to use for this request.

Returns:

The ApolloCall object with the provided RequestHeaders.

clone

@NotNull
ApolloQueryCall<T> clone()

Description copied from interface: ApolloCall

Creates a new, identical call to this one which can be enqueued or executed even if this call has already been.

Specified by:

clone in interface ApolloCall<T>

Returns:

The cloned ApolloCall object.