com.apollographql.apollo

Interface ApolloCall<T>

All Superinterfaces:

Cancelable

All Known Subinterfaces:

ApolloMutationCall<T>, ApolloQueryCall<T>

All Known Implementing Classes:

RealApolloCall

public interface ApolloCall<T>
extends Cancelable

ApolloCall is an abstraction for a request that has been prepared for execution. ApolloCall represents a single request/response pair and cannot be executed twice, though it can be cancelled.

In order to execute the request again, call the clone() method which creates a new ApolloCall object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApolloCall.Callback<T> Communicates responses from a server or offline requests.

Method Summary

Modifier and Type	Method and Description
ApolloCall<T>	cacheControl(CacheControl cacheControl) Sets the CacheControl strategy for an ApolloCall object.
ApolloCall<T>	cacheHeaders(CacheHeaders cacheHeaders) Sets the CacheHeaders to use for this call.
ApolloCall<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> callback) 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.
com.apollographql.apollo.api.Operation	operation() Returns GraphQl operation this call executes

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

cancel, isCanceled

Method Detail

execute

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

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

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

java.lang.IllegalStateException - when the call has already been executed

enqueue

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

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

Parameters:

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

Throws:

java.lang.IllegalStateException - when the call has already been executed

cacheControl

@Nonnull
ApolloCall<T> cacheControl(@Nonnull
                                    CacheControl cacheControl)

Sets the CacheControl strategy for an ApolloCall object.

Parameters:

cacheControl - the CacheControl strategy to set

Returns:

The ApolloCall object with the provided CacheControl strategy

cacheHeaders

@Nonnull
ApolloCall<T> cacheHeaders(@Nonnull
                                    CacheHeaders cacheHeaders)

Sets the CacheHeaders to use for this call.

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.

clone

@Nonnull
ApolloCall<T> clone()

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

Returns:

The cloned ApolloCall object.

operation

@Nonnull
com.apollographql.apollo.api.Operation operation()

Returns GraphQl operation this call executes

Returns:

Operation