com.apollographql.apollo

Interface GraphQLCall<T>

All Superinterfaces:

Cancelable

All Known Subinterfaces:

AppSyncMutationCall<T>, AppSyncQueryCall<T>

All Known Implementing Classes:

RealAppSyncCall

public interface GraphQLCall<T>
extends Cancelable

GraphQLCall is an abstraction for a request that has been prepared for execution. GraphQLCall 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 GraphQLCall object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GraphQLCall.Callback<T> Communicates responses from a server or offline requests.
static class	GraphQLCall.StatusEvent Represents a status event that corresponds to a GraphQLCall action

Method Summary

Modifier and Type	Method and Description
GraphQLCall<T>	cacheHeaders(CacheHeaders cacheHeaders) Sets the CacheHeaders to use for this call.
void	cancel() Cancels this GraphQLCall.
GraphQLCall<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(GraphQLCall.Callback<T> callback) Schedules the request to be executed at some point in the future.
com.apollographql.apollo.api.Operation	operation() Returns GraphQL operation this call executes

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

isCanceled

Method Detail

enqueue

void enqueue(@Nullable
             GraphQLCall.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

cacheHeaders

@Nonnull
GraphQLCall<T> cacheHeaders(@Nonnull
                                     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.

Parameters:

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

Returns:

The GraphQLCall object with the provided CacheHeaders.

clone

@Nonnull
GraphQLCall<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 GraphQLCall object.

operation

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

Returns GraphQL operation this call executes

Returns:

Operation

cancel

void cancel()

Cancels this GraphQLCall. If the call has already completed, nothing will happen. If the call is outgoing, an ApolloCanceledException will be thrown if the call was started with #execute(). If the call was started with enqueue(Callback) the GraphQLCall.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 Cancelable