com.amazonaws.mobileconnectors.appsync

Class AWSAppSyncClient

java.lang.Object

com.amazonaws.mobileconnectors.appsync.AWSAppSyncClient

public class AWSAppSyncClient
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AWSAppSyncClient.AWSAppSyncDeltaSyncWatcher
static class	AWSAppSyncClient.Builder

Method Summary

Modifier and Type	Method and Description
static AWSAppSyncClient.Builder	builder()
void	clearCaches() Clears the different client databases on the local device which stores the following: 1) Query Cache - query responses 2) Mutation Queue - offline persistent mutations 3) Delta Sync Metadata Cache - Subscriptions Metadata If there are only on-going delta sync operations, they won't be impacted.
void	clearCaches(ClearCacheOptions clearCacheOptions) Clears the different client databases on the local device based on the ClearCacheOptions object passed in.
void	clearMutationQueue() Deprecated. Since 2.9.0. This method will be removed in the next minor version. Please use #clearCaches(ClearCacheOptions.builder() .clearMutations().build()) instead.
com.apollographql.apollo.api.S3ObjectManager	getS3ObjectManager()
AppSyncStore	getStore()
boolean	isMutationQueueEmpty() Used to check if the mutation queue is empty.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncMutationCall<T>	mutate(com.apollographql.apollo.api.Mutation<D,T,V> mutation)
protected <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncMutationCall<T>	mutate(com.apollographql.apollo.api.Mutation<D,T,V> mutation, boolean isRetry)
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncMutationCall<T>	mutate(com.apollographql.apollo.api.Mutation<D,T,V> mutation, D withOptimisticUpdates)
protected <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncMutationCall<T>	mutate(com.apollographql.apollo.api.Mutation<D,T,V> mutation, D withOptimisticUpdates, boolean isRetry)
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncQueryCall<T>	query(com.apollographql.apollo.api.Query<D,T,V> query)
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncSubscriptionCall<T>	subscribe(com.apollographql.apollo.api.Subscription<D,T,V> subscription) Subscribes to updates from a GraphQL endpoint.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.apollographql.apollo.internal.util.Cancelable	sync(com.apollographql.apollo.api.Query<D,T,V> baseQuery, com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> baseQueryCallback, long baseRefreshIntervalInSeconds) Provides the ability to sync using a baseQuery and a refresh interval
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.apollographql.apollo.internal.util.Cancelable	sync(com.apollographql.apollo.api.Query<D,T,V> baseQuery, com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> baseQueryCallback, com.apollographql.apollo.api.Query<D,T,V> deltaQuery, com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> deltaQueryCallback, long baseRefreshIntervalInSeconds) Provides the ability to sync using a baseQuery, deltaQuery, and a refresh interval
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.apollographql.apollo.internal.util.Cancelable	sync(com.apollographql.apollo.api.Query<D,T,V> baseQuery, com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> baseQueryCallback, com.apollographql.apollo.api.Subscription<D,T,V> subscription, com.amazonaws.mobileconnectors.appsync.AppSyncSubscriptionCall.Callback subscriptionCallback) Provides the ability to sync using a baseQuery and Subscription
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.apollographql.apollo.internal.util.Cancelable	sync(com.apollographql.apollo.api.Query<D,T,V> baseQuery, com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> baseQueryCallback, com.apollographql.apollo.api.Subscription<D,T,V> subscription, com.amazonaws.mobileconnectors.appsync.AppSyncSubscriptionCall.Callback subscriptionCallback, com.apollographql.apollo.api.Query<D,T,V> deltaQuery, com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> deltaQueryCallback, long baseRefreshIntervalInSeconds) Provides the ability to sync using a baseQuery, deltaQuery, subscription, and a refresh interval

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AWSAppSyncClient.Builder builder()

Returns:

builder object

query

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncQueryCall<T> query(@Nonnull
                                                                                                                                                                                             com.apollographql.apollo.api.Query<D,T,V> query)

mutate

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncMutationCall<T> mutate(@Nonnull
                                                                                                                                                                                                 com.apollographql.apollo.api.Mutation<D,T,V> mutation)

mutate

protected <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncMutationCall<T> mutate(@Nonnull
                                                                                                                                                                                                    com.apollographql.apollo.api.Mutation<D,T,V> mutation,
                                                                                                                                                                                                    boolean isRetry)

mutate

protected <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncMutationCall<T> mutate(@Nonnull
                                                                                                                                                                                                    com.apollographql.apollo.api.Mutation<D,T,V> mutation,
                                                                                                                                                                                                    @Nonnull
                                                                                                                                                                                                    D withOptimisticUpdates,
                                                                                                                                                                                                    boolean isRetry)

subscribe

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncSubscriptionCall<T> subscribe(@Nonnull
                                                                                                                                                                                                        com.apollographql.apollo.api.Subscription<D,T,V> subscription)

Subscribes to updates from a GraphQL endpoint.

Type Parameters:

D - Response data class for the GraphQL Operation

T - callback data type. This is usually same as D, the response data type

V - Variables associated with the GraphQL Operations

Parameters:

subscription - GraphQL Subscription

Returns:

Returns an appsync subscription call AppSyncSubscriptionCall

mutate

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.amazonaws.mobileconnectors.appsync.AppSyncMutationCall<T> mutate(@Nonnull
                                                                                                                                                                                                 com.apollographql.apollo.api.Mutation<D,T,V> mutation,
                                                                                                                                                                                                 @Nonnull
                                                                                                                                                                                                 D withOptimisticUpdates)

getStore

public AppSyncStore getStore()

getS3ObjectManager

public com.apollographql.apollo.api.S3ObjectManager getS3ObjectManager()

sync

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.apollographql.apollo.internal.util.Cancelable sync(@Nonnull
                                                                                                                                                                                   com.apollographql.apollo.api.Query<D,T,V> baseQuery,
                                                                                                                                                                                   com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> baseQueryCallback,
                                                                                                                                                                                   com.apollographql.apollo.api.Subscription<D,T,V> subscription,
                                                                                                                                                                                   com.amazonaws.mobileconnectors.appsync.AppSyncSubscriptionCall.Callback subscriptionCallback,
                                                                                                                                                                                   com.apollographql.apollo.api.Query<D,T,V> deltaQuery,
                                                                                                                                                                                   com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> deltaQueryCallback,
                                                                                                                                                                                   long baseRefreshIntervalInSeconds)

Provides the ability to sync using a baseQuery, deltaQuery, subscription, and a refresh interval

Type Parameters:

D -

T -

V -

Parameters:

baseQuery - the base query to get the baseline state

baseQueryCallback - callback to handle the baseQuery results

subscription - subscription to get changes on the fly

subscriptionCallback - callback to handle the subscription messages

deltaQuery - the catchup query

deltaQueryCallback - callback to handle the deltaQuery results

baseRefreshIntervalInSeconds - time duration (specified in seconds) when the base query will be re-run to get an updated baseline state.

Returns:

a Cancelable object that can be used later to cancel the sync operation by calling the cancel() method

sync

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.apollographql.apollo.internal.util.Cancelable sync(@Nonnull
                                                                                                                                                                                   com.apollographql.apollo.api.Query<D,T,V> baseQuery,
                                                                                                                                                                                   com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> baseQueryCallback,
                                                                                                                                                                                   long baseRefreshIntervalInSeconds)

Provides the ability to sync using a baseQuery and a refresh interval

Type Parameters:

D -

T -

V -

Parameters:

baseQuery - the base query to get the baseline state

baseQueryCallback - callback to handle the baseQuery results

baseRefreshIntervalInSeconds - time duration (specified in seconds) when the base query will be re-run to get an updated baseline state.

Returns:

a Cancelable object that can be used later to cancel the sync operation by calling the cancel() method

sync

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.apollographql.apollo.internal.util.Cancelable sync(@Nonnull
                                                                                                                                                                                   com.apollographql.apollo.api.Query<D,T,V> baseQuery,
                                                                                                                                                                                   com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> baseQueryCallback,
                                                                                                                                                                                   com.apollographql.apollo.api.Query<D,T,V> deltaQuery,
                                                                                                                                                                                   com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> deltaQueryCallback,
                                                                                                                                                                                   long baseRefreshIntervalInSeconds)

Provides the ability to sync using a baseQuery, deltaQuery, and a refresh interval

Type Parameters:

D -

T -

V -

Parameters:

baseQuery - the base query to get the baseline state

baseQueryCallback - callback to handle the baseQuery results

deltaQuery - the catchup query

deltaQueryCallback - callback to handle the deltaQuery results

baseRefreshIntervalInSeconds - time duration (specified in seconds) when the base query will be re-run to get an updated baseline state.

Returns:

a Cancelable object that can be used later to cancel the sync operation by calling the cancel() method

sync

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.apollographql.apollo.internal.util.Cancelable sync(@Nonnull
                                                                                                                                                                                   com.apollographql.apollo.api.Query<D,T,V> baseQuery,
                                                                                                                                                                                   com.apollographql.apollo.GraphQLCall.Callback<com.apollographql.apollo.api.Operation.Data> baseQueryCallback,
                                                                                                                                                                                   com.apollographql.apollo.api.Subscription<D,T,V> subscription,
                                                                                                                                                                                   com.amazonaws.mobileconnectors.appsync.AppSyncSubscriptionCall.Callback subscriptionCallback)

Provides the ability to sync using a baseQuery and Subscription

Type Parameters:

D -

T -

V -

Parameters:

baseQuery - the base query to get the baseline state

baseQueryCallback - callback to handle the baseQuery results

subscription - subscription to get changes on the fly

subscriptionCallback - callback to handle the subscription messages

Returns:

a Cancelable object that can be used later to cancel the sync operation by calling the cancel() method

isMutationQueueEmpty

public boolean isMutationQueueEmpty()

Used to check if the mutation queue is empty.

Returns:

true if queue is empty, false otherwise.

clearMutationQueue

@Deprecated
public void clearMutationQueue()

Deprecated. Since 2.9.0. This method will be removed in the next minor version. Please use #clearCaches(ClearCacheOptions.builder() .clearMutations().build()) instead.

Clear the mutation queue. A Mutation that is currently in progress will continue to execute until finished.

clearCaches

public void clearCaches()
                 throws ClearCacheException

Clears the different client databases on the local device which stores the following: 1) Query Cache - query responses 2) Mutation Queue - offline persistent mutations 3) Delta Sync Metadata Cache - Subscriptions Metadata If there are only on-going delta sync operations, they won't be impacted.

Throws:

ClearCacheException

clearCaches

public void clearCaches(ClearCacheOptions clearCacheOptions)
                 throws ClearCacheException

Clears the different client databases on the local device based on the ClearCacheOptions object passed in. 1) ClearCacheOptions#clearQueries - Query Cache - query responses 2) ClearCacheOptions#clearMutations - Mutation Queue - offline persistent mutations 3) ClearCacheOptions#clearSubscriptions - Delta Sync Metadata Cache - Subscriptions Metadata If there are only on-going delta sync operations, it is recommended to cancel those operations before calling clearCaches.

Throws:

ClearCacheException