com.apollographql.apollo.internal.subscription.SubscriptionManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-android-sdk-appsync-runtime Show documentation

AWS AppSync GraphQL runtime library to support generated code

There is a newer version: 3.4.2

Show newest version

/**
 * Copyright 2018-2019 Amazon.com,
 * Inc. or its affiliates. All Rights Reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package com.apollographql.apollo.internal.subscription;

import com.amazonaws.mobileconnectors.appsync.AppSyncSubscriptionCall;
import com.amazonaws.mobileconnectors.appsync.subscription.SubscriptionResponse;
import com.apollographql.apollo.api.Response;
import com.apollographql.apollo.api.Subscription;
import com.apollographql.apollo.cache.normalized.ApolloStore;
import com.apollographql.apollo.internal.cache.normalized.ResponseNormalizer;
import com.apollographql.apollo.internal.response.ScalarTypeAdapters;

import java.util.List;
import java.util.Map;

import javax.annotation.Nonnull;

public interface SubscriptionManager {

    /**
     * Make a connection and subscribe to all topics.
     * @param  The type of the repsonse data
     * @param subscription The operation that has parsing logic, operation id, etc.
     * @param subbedTopics The topics relevant to the subscription.
     * @param response list of mqtt connections and topics
     * @param mapResponseNormalizer
     */
     void subscribe(
            @Nonnull Subscription subscription,
            @Nonnull final List subbedTopics,
            @Nonnull SubscriptionResponse response,
            ResponseNormalizer> mapResponseNormalizer);

    void unsubscribe(@Nonnull Subscription subscription);

    /**
     * Sets the listener based on the subscription's operation (unique) id
     * @param subscription The subscription for which callbacks will be triggered.
     * @param callback The callback for messages received on the subscription connection.
     */
    void addListener(Subscription subscription, AppSyncSubscriptionCall.Callback callback);

    /**
     * Removes the listener based on the subscription's operation (unique) id
     * @param subscription The subscription for which callbacks will be triggered.
     * @param callback The callback for messages received on the subscription connection.
     */
    void removeListener(Subscription subscription, AppSyncSubscriptionCall.Callback callback);

    /**
     * Sets the store used for cache updates based on subscription responses.
     * @param apolloStore
     */
    void setStore(ApolloStore apolloStore);

    void setScalarTypeAdapters(ScalarTypeAdapters scalarTypeAdapters);

    interface Callback {
        void onResponse(@Nonnull Response response);

        void onError(@Nonnull Exception error);

        void onNetworkError(@Nonnull Throwable t);

        void onCompleted();
    }
}