Package com.apollographql.apollo

Interface ApolloSubscriptionCall<T>

All Superinterfaces:

Cancelable

All Known Implementing Classes:

RealApolloSubscriptionCall

public interface ApolloSubscriptionCall<T>
extends Cancelable

ApolloSubscriptionCall is an abstraction for a request that has been prepared for subscription. ApolloSubscriptionCall cannot be executed twice, though it can be cancelled. Any updates pushed by server related to provided subscription will be notified via ApolloSubscriptionCall.Callback

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ApolloSubscriptionCall.CachePolicy	Subscription normalized cache policy.
static interface	ApolloSubscriptionCall.Callback<T>	Communicates responses from a subscription server.
static interface	ApolloSubscriptionCall.Factory	Factory for creating ApolloSubscriptionCall calls.

Method Summary

Modifier and Type	Method	Description
ApolloSubscriptionCall<T>	cachePolicy(ApolloSubscriptionCall.CachePolicy cachePolicy)	Sets the cache policy for response/request cache.
ApolloSubscriptionCall<T>	clone()	Creates a new, identical call to this one which can be executed even if this call has already been.
void	execute(ApolloSubscriptionCall.Callback<T> callback)	Sends Subscription to the subscription server and starts listening for the pushed updates.

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

cancel, isCanceled

Method Detail

execute

void execute(@NotNull
             ApolloSubscriptionCall.Callback<T> callback)

Sends Subscription to the subscription server and starts listening for the pushed updates. To cancel this subscription call use Cancelable.cancel().

Parameters:

callback - which will handle the subscription updates or a failure exception.

Throws:

ApolloCanceledException - when the call has already been canceled

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

clone

ApolloSubscriptionCall<T> clone()

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

Returns:

The cloned ApolloSubscriptionCall object.

cachePolicy

@NotNull
ApolloSubscriptionCall<T> cachePolicy(@NotNull
                                      ApolloSubscriptionCall.CachePolicy cachePolicy)

Sets the cache policy for response/request cache.

Parameters:

cachePolicy - ApolloSubscriptionCall.CachePolicy to set

Returns:

ApolloSubscriptionCall with the provided ApolloSubscriptionCall.CachePolicy