com.apollographql.apollo

Interface ApolloMutationCall<T>

All Superinterfaces:

ApolloCall<T>, Cancelable

All Known Implementing Classes:

RealApolloCall

public interface ApolloMutationCall<T>
extends ApolloCall<T>

A call prepared to execute GraphQL mutation operation.

Nested Class Summary

Nested Classes

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

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

ApolloCall.Callback<T>, ApolloCall.StatusEvent

Method Summary

Modifier and Type	Method and Description
ApolloMutationCall<T>	cacheHeaders(com.apollographql.apollo.cache.CacheHeaders cacheHeaders) Sets the CacheHeaders to use for this call.
ApolloMutationCall<T>	clone() Creates a new, identical call to this one which can be enqueued or executed even if this call has already been.
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.
ApolloMutationCall<T>	requestHeaders(RequestHeaders requestHeaders) Sets the RequestHeaders to use for this call.

Methods inherited from interface com.apollographql.apollo.ApolloCall

cancel, enqueue, operation

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

isCanceled

Method Detail

refetchQueries

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

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

Parameters:

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

Returns:

ApolloMutationCall that will trigger re-fetching provided queries

refetchQueries

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

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

Parameters:

queries - array of Query to be re-fetched

Returns:

ApolloMutationCall that will trigger re-fetching provided queries

cacheHeaders

@NotNull
ApolloMutationCall<T> cacheHeaders(@NotNull
                                            com.apollographql.apollo.cache.CacheHeaders cacheHeaders)

Description copied from interface: ApolloCall

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.

requestHeaders

@NotNull
ApolloMutationCall<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
ApolloMutationCall<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.