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>

Method Summary

Modifier and Type	Method and Description
static <T> RealApolloCall.Builder<T>	builder()
RealApolloCall<T>	cacheControl(CacheControl cacheControl) Sets the CacheControl strategy for an ApolloCall object.
RealApolloCall<T>	cacheHeaders(CacheHeaders cacheHeaders) Sets the CacheHeaders to use for this call.
void	cancel() Cancels the operation.
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.
com.apollographql.apollo.api.Response<T>	execute() Sends the request immediately and blocks until the response can be processed or is an error.
RealApolloCall<T>	httpCachePolicy(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.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()

execute

@Nonnull
public com.apollographql.apollo.api.Response<T> execute()
                                                          throws ApolloException

Description copied from interface: ApolloCall

Sends the request immediately and blocks until the response can be processed or is an error.

Specified by:

execute in interface ApolloCall<T>

Returns:

The successful or failed Response

Throws:

ApolloException - if the request could not be executed due to a cancellation, a timeout, network failure or a parsing error

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

@Nonnull
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

@Nonnull
public RealApolloCall<T> httpCachePolicy(@Nonnull
                                                  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

cacheControl

@Nonnull
public RealApolloCall<T> cacheControl(@Nonnull
                                               CacheControl cacheControl)

Description copied from interface: ApolloCall

Sets the CacheControl strategy for an ApolloCall object.

Specified by:

cacheControl in interface ApolloCall<T>

Specified by:

cacheControl in interface ApolloQueryCall<T>

Parameters:

cacheControl - the CacheControl strategy to set

Returns:

The ApolloCall object with the provided CacheControl strategy

cacheHeaders

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

Description copied from interface: ApolloCall

Sets the CacheHeaders to use 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.

cancel

public void cancel()

Description copied from interface: Cancelable

Cancels the operation.

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

@Nonnull
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

@Nonnull
public ApolloMutationCall<T> refetchQueries(@Nonnull
                                                     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

@Nonnull
public ApolloMutationCall<T> refetchQueries(@Nonnull
                                                     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

@Nonnull
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()