commonMain.com.apollographql.apollo3.api.Fragment.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apollo-api-jvm Show documentation

Apollo GraphQL API classes

There is a newer version: 4.0.0-beta.7

package com.apollographql.apollo3.api

import com.apollographql.apollo3.api.json.JsonWriter
import okio.IOException

/**
 * Base interface for a fragment implementation.
 * Fragments do not have variables per the GraphQL spec but they are inferred from arguments and used when reading the cache
 * See https://github.com/graphql/graphql-spec/issues/204 for a proposal to add fragment arguments
 */
interface Fragment : Executable {
  @Throws(IOException::class)
  override fun serializeVariables(writer: JsonWriter, customScalarAdapters: CustomScalarAdapters, withBooleanDefaultValues: Boolean)

  override fun adapter(): CompositeAdapter

  override fun rootField(): CompiledField

  /**
   * Marker interface for generated models of this fragment
   */
  interface Data : Executable.Data
}