com.apollographql.apollo.internal

Class RealApolloSubscriptionCall<T>

java.lang.Object

com.apollographql.apollo.internal.RealApolloSubscriptionCall<T>

All Implemented Interfaces:

ApolloSubscriptionCall<T>, Cancelable

public class RealApolloSubscriptionCall<T>
extends java.lang.Object
implements ApolloSubscriptionCall<T>

Nested Class Summary

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

ApolloSubscriptionCall.CachePolicy, ApolloSubscriptionCall.Callback<T>, ApolloSubscriptionCall.Factory

Constructor Summary

Constructors

Constructor and Description
RealApolloSubscriptionCall(com.apollographql.apollo.api.Subscription<?,T,?> subscription, SubscriptionManager subscriptionManager, ApolloStore apolloStore, ApolloSubscriptionCall.CachePolicy cachePolicy, java.util.concurrent.Executor dispatcher, ResponseFieldMapperFactory responseFieldMapperFactory, com.apollographql.apollo.internal.ApolloLogger logger)

Method Summary

Modifier and Type	Method and Description
ApolloSubscriptionCall<T>	cachePolicy(ApolloSubscriptionCall.CachePolicy cachePolicy) Sets the cache policy for response/request cache.
void	cancel() Cancels the operation.
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.
boolean	isCanceled() Checks if this operation has been canceled.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealApolloSubscriptionCall

public RealApolloSubscriptionCall(@NotNull
                                  com.apollographql.apollo.api.Subscription<?,T,?> subscription,
                                  @NotNull
                                  SubscriptionManager subscriptionManager,
                                  @NotNull
                                  ApolloStore apolloStore,
                                  @NotNull
                                  ApolloSubscriptionCall.CachePolicy cachePolicy,
                                  @NotNull
                                  java.util.concurrent.Executor dispatcher,
                                  @NotNull
                                  ResponseFieldMapperFactory responseFieldMapperFactory,
                                  @NotNull
                                  com.apollographql.apollo.internal.ApolloLogger logger)

Method Detail

execute

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

Description copied from interface: ApolloSubscriptionCall

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

Specified by:

execute in interface ApolloSubscriptionCall<T>

Parameters:

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

Throws:

ApolloCanceledException - when the call has already been canceled

cancel

public void cancel()

Description copied from interface: Cancelable

Cancels the operation.

Specified by:

cancel in interface Cancelable

clone

public ApolloSubscriptionCall<T> clone()

Description copied from interface: ApolloSubscriptionCall

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

Specified by:

clone in interface ApolloSubscriptionCall<T>

Overrides:

clone in class java.lang.Object

Returns:

The cloned ApolloSubscriptionCall object.

isCanceled

public boolean isCanceled()

Description copied from interface: Cancelable

Checks if this operation has been canceled.

Specified by:

isCanceled in interface Cancelable

Returns:

true if this operation has been canceled else returns false

cachePolicy

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

Description copied from interface: ApolloSubscriptionCall

Sets the cache policy for response/request cache.

Specified by:

cachePolicy in interface ApolloSubscriptionCall<T>

Parameters:

cachePolicy - ApolloSubscriptionCall.CachePolicy to set

Returns:

ApolloSubscriptionCall with the provided ApolloSubscriptionCall.CachePolicy