com.apollographql.apollo.internal

Class RealApolloCall<T>

java.lang.Object

com.apollographql.apollo.internal.RealApolloCall<T>

All Implemented Interfaces:

ApolloCall<T>, ApolloMutationCall<T>, ApolloQueryCall<T>, Cancelable

public final class RealApolloCall<T>
extends java.lang.Object
implements ApolloQueryCall<T>, ApolloMutationCall<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RealApolloCall.Builder<T>

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

ApolloQueryCall.Factory

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

ApolloMutationCall.Factory

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

ApolloCall.Callback<T>, ApolloCall.StatusEvent

Method Summary

Modifier and Type	Method and Description
static <T> RealApolloCall.Builder<T>	builder()
RealApolloCall<T>	cacheHeaders(CacheHeaders cacheHeaders) Sets the CacheHeaders to use for this call.
void	cancel() Cancels this ApolloCall.
RealApolloCall<T>	clone() Creates a new, identical call to this one which can be enqueued or executed even if this call has already been.
void	enqueue(ApolloCall.Callback<T> responseCallback) Schedules the request to be executed at some point in the future.
RealApolloCall<T>	httpCachePolicy(com.apollographql.apollo.api.cache.http.HttpCachePolicy.Policy httpCachePolicy) Sets the http cache policy for response/request cache.
boolean	isCanceled() Checks if this operation has been canceled.
com.apollographql.apollo.api.Operation	operation() Returns GraphQL operation this call executes
ApolloMutationCall<T>	refetchQueries(com.apollographql.apollo.api.OperationName... operationNames) Sets a list of ApolloQueryWatcher query names to be re-fetched once this mutation completed.
ApolloMutationCall<T>	refetchQueries(com.apollographql.apollo.api.Query... queries) Sets a list of Query to be re-fetched once this mutation completed.
RealApolloCall<T>	requestHeaders(RequestHeaders requestHeaders) Sets the RequestHeaders to use for this call.
RealApolloCall<T>	responseFetcher(ResponseFetcher fetcher) Sets the ResponseFetcher strategy for an ApolloCall object.
RealApolloCall.Builder<T>	toBuilder()
com.apollographql.apollo.internal.RealApolloQueryWatcher<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 class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static <T> RealApolloCall.Builder<T> builder()

enqueue

public void enqueue(@Nullable
                    ApolloCall.Callback<T> responseCallback)

Description copied from interface: ApolloCall

Schedules the request to be executed at some point in the future.

Specified by:

enqueue in interface ApolloCall<T>

Parameters:

responseCallback - Callback which will handle the response or a failure exception.

watcher

@NotNull
public com.apollographql.apollo.internal.RealApolloQueryWatcher<T> watcher()

Description copied from interface: ApolloQueryCall

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...)

Specified by:

watcher in interface ApolloQueryCall<T>

Returns:

ApolloQueryWatcher

httpCachePolicy

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

Description copied from interface: ApolloQueryCall

Sets the http cache policy for response/request cache.

Specified by:

httpCachePolicy in interface ApolloQueryCall<T>

Parameters:

httpCachePolicy - HttpCachePolicy.Policy to set

Returns:

ApolloQueryCall with the provided HttpCachePolicy.Policy

responseFetcher

@NotNull
public RealApolloCall<T> responseFetcher(@NotNull
                                                  ResponseFetcher fetcher)

Description copied from interface: ApolloQueryCall

Sets the ResponseFetcher strategy for an ApolloCall object.

Specified by:

responseFetcher in interface ApolloQueryCall<T>

Parameters:

fetcher - the ResponseFetcher to use.

Returns:

The ApolloCall object with the provided CacheControl strategy

cacheHeaders

@NotNull
public RealApolloCall<T> cacheHeaders(@NotNull
                                               CacheHeaders cacheHeaders)

Description copied from interface: ApolloQueryCall

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>

Specified by:

cacheHeaders in interface ApolloMutationCall<T>

Specified by:

cacheHeaders in interface ApolloQueryCall<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.

requestHeaders

@NotNull
public RealApolloCall<T> requestHeaders(@NotNull
                                                 RequestHeaders requestHeaders)

Description copied from interface: ApolloQueryCall

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.

Specified by:

requestHeaders in interface ApolloMutationCall<T>

Specified by:

requestHeaders in interface ApolloQueryCall<T>

Parameters:

requestHeaders - The RequestHeaders to use for this request.

Returns:

The ApolloCall object with the provided RequestHeaders.

cancel

public void cancel()

Description copied from interface: ApolloCall

Cancels this ApolloCall. If the call was started with ApolloCall.enqueue(Callback), the ApolloCall.Callback will be disposed, and will receive no more events. The call will attempt to abort and release resources, if possible.

Specified by:

cancel in interface ApolloCall<T>

Specified by:

cancel in interface Cancelable

isCanceled

public boolean isCanceled()

Description copied from interface: Cancelable

Checks if this operation has been canceled.

Specified by:

isCanceled in interface Cancelable

Returns:

true if this operation has been canceled else returns false

clone

@NotNull
public RealApolloCall<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>

Specified by:

clone in interface ApolloMutationCall<T>

Specified by:

clone in interface ApolloQueryCall<T>

Overrides:

clone in class java.lang.Object

Returns:

The cloned ApolloCall object.

refetchQueries

@NotNull
public ApolloMutationCall<T> refetchQueries(@NotNull
                                                     com.apollographql.apollo.api.OperationName... operationNames)

Description copied from interface: ApolloMutationCall

Sets a list of ApolloQueryWatcher query names to be re-fetched once this mutation completed.

Specified by:

refetchQueries in interface ApolloMutationCall<T>

Parameters:

operationNames - array of OperationName query names to be re-fetched

Returns:

ApolloMutationCall that will trigger re-fetching provided queries

refetchQueries

@NotNull
public ApolloMutationCall<T> refetchQueries(@NotNull
                                                     com.apollographql.apollo.api.Query... queries)

Description copied from interface: ApolloMutationCall

Sets a list of Query to be re-fetched once this mutation completed.

Specified by:

refetchQueries in interface ApolloMutationCall<T>

Parameters:

queries - array of Query to be re-fetched

Returns:

ApolloMutationCall that will trigger re-fetching provided queries

operation

@NotNull
public com.apollographql.apollo.api.Operation operation()

Description copied from interface: ApolloCall

Returns GraphQL operation this call executes

Specified by:

operation in interface ApolloCall<T>

Returns:

Operation

toBuilder

public RealApolloCall.Builder<T> toBuilder()