com.apollographql.apollo3.fetcher.ApolloResponseFetchers.kt Maven / Gradle / Ivy

Go to download
package com.apollographql.apollo3.fetcher

import com.apollographql.apollo3.internal.fetcher.CacheAndNetworkFetcher
import com.apollographql.apollo3.internal.fetcher.CacheFirstFetcher
import com.apollographql.apollo3.internal.fetcher.CacheOnlyFetcher
import com.apollographql.apollo3.internal.fetcher.NetworkFirstFetcher
import com.apollographql.apollo3.internal.fetcher.NetworkOnlyFetcher

object ApolloResponseFetchers {
  /**
   * Signals the apollo client to **only** fetch the data from the normalized cache. If it's not present in
   * the normalized cache or if an exception occurs while trying to fetch it from the normalized cache, an empty [ ] is sent back with the [com.apollographql.apollo3.api.Operation] info
   * wrapped inside.
   */
  val CACHE_ONLY: ResponseFetcher = CacheOnlyFetcher()

  /**
   * Signals the apollo client to **only** fetch the GraphQL data from the network. If network request fails, an
   * exception is thrown.
   */
  @JvmField
  val NETWORK_ONLY: ResponseFetcher = NetworkOnlyFetcher()

  /**
   * Signals the apollo client to first fetch the data from the normalized cache. If it's not present in the
   * normalized cache or if an exception occurs while trying to fetch it from the normalized cache, then the data is
   * instead fetched from the network.
   */
  @JvmField
  val CACHE_FIRST: ResponseFetcher = CacheFirstFetcher()

  /**
   * Signals the apollo client to first fetch the data from the network. If network request fails, then the
   * data is fetched from the normalized cache. If the data is not present in the normalized cache, then the
   * exception which led to the network request failure is rethrown.
   */
  val NETWORK_FIRST: ResponseFetcher = NetworkFirstFetcher()

  /**
   * Signal the apollo client to fetch the data from both the network and the cache. If cached data is not
   * present, only network data will be returned. If cached data is available, but network experiences an error,
   * cached data is first returned, followed by the network error. If cache data is not available, and network
   * data is not available, the error of the network request will be propagated. If both network and cache
   * are available, both will be returned. Cache data is guaranteed to be returned first.
   */
  val CACHE_AND_NETWORK: ResponseFetcher = CacheAndNetworkFetcher()
}