class CodegenMetadata( val version: String, val targetLanguage: TargetLanguage, val entries: List<ResolverEntry>, val inlineProperties: Map<String, String?>, val scalarTargets: Map<String, String>, val scalarAdapters: Map<String, String>, val scalarIsUserDefined: Map<String, Boolean>)

CodegenMetadata contains information about what target classes were generated for each GraphQL types so that downstream modules can reuse them.

CodegenOptions

@Serializable

class CodegenOptions( val targetLanguage: TargetLanguage?, val packageName: String?, val rootPackageName: String?, val decapitalizeFields: Boolean?, val useSemanticNaming: Boolean?, val generateMethods: List<GeneratedMethod>?, val operationManifestFormat: String?, val generateSchema: Boolean?, val generatedSchemaName: String?, val sealedClassesForEnumsMatching: List<String>?, val generateAsInternal: Boolean?, val addUnknownForEnums: Boolean?, val addDefaultArgumentForInputObjects: Boolean?, val generateFilterNotNull: Boolean?, val generateInputBuilders: Boolean?, val addJvmOverloads: Boolean?, val requiresOptInAnnotation: String?, val jsExport: Boolean?, val generateModelBuilders: Boolean?, val classesForEnumsMatching: List<String>?, val generatePrimitiveTypes: Boolean?, val nullableFieldStyle: JavaNullable?, val generateFragmentImplementations: Boolean?, val generateQueryDocument: Boolean?) : SchemaCodegenOptions, OperationsCodegenOptions

CodegenSchema

@Serializable

class CodegenSchema(val schema: Schema, val normalizedPath: String)

A Schema linked with other options that are bound to this schema and need to be the same in all modules using this schema

CodegenSchemaOptions

@Serializable

class CodegenSchemaOptions( val scalarTypeMapping: Map<String, String>, val scalarAdapterMapping: Map<String, String>, val generateDataBuilders: Boolean)

CommonCodegenOpt

interface CommonCodegenOpt

DocumentTransform

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_2_1)

interface ~~DocumentTransform~~

A DocumentTransform transforms operations and fragments at build time. DocumentTransform can add or remove fields automatically for an example.

EntryPoints

object EntryPoints

EntryPoints is a higher level API compared to ApolloCompiler. It deals with compiler plugins and serializing/deserializing files.

ExecutableDocumentTransform

@ApolloExperimental

fun interface ExecutableDocumentTransform

A ExecutableDocumentTransform transforms operations and fragments at build time. ExecutableDocumentTransform can add or remove fields automatically, for an example.

ExpressionAdapterInitializer

@Serializable

@SerialName(value = "expression")

class ExpressionAdapterInitializer(val expression: String) : AdapterInitializer

The adapter expression will be used as-is (can be an object, a public val, a class instantiation).

GeneratedMethod

enum GeneratedMethod : Enum<GeneratedMethod>

InputFile

class InputFile(val file: File, val normalizedPath: String)

An input file together with its normalizedPath. normalizedPath is used to compute the package name in some cases

IrOptions

@Serializable

class IrOptions( val fieldsOnDisjointTypesMustMerge: Boolean?, val decapitalizeFields: Boolean?, val flattenModels: Boolean?, val warnOnDeprecatedUsages: Boolean?, val failOnWarnings: Boolean?, val addTypename: String?, val generateOptionalOperationVariables: Boolean?, val alwaysGenerateTypesMatching: Set<String>?, val codegenModels: String?)

JavaCodegenOpt

interface JavaCodegenOpt

JavaNullable

enum JavaNullable : Enum<JavaNullable>

JavaOperationsCodegenOptions

interface JavaOperationsCodegenOptions : CommonCodegenOpt, OperationsCodegenOpt, JavaCodegenOpt

JavaSchemaCodegenOptions

interface JavaSchemaCodegenOptions : CommonCodegenOpt, SchemaCodegenOpt, JavaCodegenOpt

KotlinCodegenOpt

interface KotlinCodegenOpt

KotlinOperationsCodegenOptions

interface KotlinOperationsCodegenOptions : CommonCodegenOpt, OperationsCodegenOpt, KotlinCodegenOpt

KotlinSchemaCodegenOptions

interface KotlinSchemaCodegenOptions : CommonCodegenOpt, SchemaCodegenOpt, KotlinCodegenOpt

LayoutFactory

fun interface LayoutFactory

OperationIdsGenerator

@ApolloExperimental

fun interface OperationIdsGenerator

An OperationIdsGenerator is responsible for computing OperationId from OperationDescriptor.

OperationsCodegenOpt

interface OperationsCodegenOpt

OperationsCodegenOptions

interface OperationsCodegenOptions : JavaOperationsCodegenOptions, KotlinOperationsCodegenOptions

Order

@ApolloExperimental

sealed interface Order

RuntimeAdapterInitializer

@Serializable

@SerialName(value = "runtime")

object RuntimeAdapterInitializer : AdapterInitializer

The adapter instance will be looked up in the com.apollographql.apollo.api.CustomScalarAdapters provided at runtime.

SchemaCodeGenerator

@ApolloExperimental

fun interface SchemaCodeGenerator

A code generator that may write extra schema code in addition to what the Apollo Kotlin compiler is generating.

SchemaCodegenOpt

interface SchemaCodegenOpt

SchemaCodegenOptions

interface SchemaCodegenOptions : JavaSchemaCodegenOptions, KotlinSchemaCodegenOptions

SchemaDocumentTransform

fun interface SchemaDocumentTransform

A SchemaDocumentTransform transforms the schema at build time.

SchemaListener

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_2_1)

interface ~~SchemaListener~~

TargetLanguage

enum TargetLanguage : Enum<TargetLanguage>

Transform

@ApolloExperimental

fun interface Transform<T>

Transforms a type

UsedCoordinates

@Serializable

class UsedCoordinates

Properties

ADD_TYPENAME_ALWAYS

@JvmField

val ADD_TYPENAME_ALWAYS: String

ADD_TYPENAME_IF_ABSTRACT

@JvmField

val ADD_TYPENAME_IF_ABSTRACT: String

ADD_TYPENAME_IF_FRAGMENTS

@JvmField

val ADD_TYPENAME_IF_FRAGMENTS: String

ADD_TYPENAME_IF_POLYMORPHIC

@JvmField

val ADD_TYPENAME_IF_POLYMORPHIC: String

APOLLO_VERSION

@JvmField

val APOLLO_VERSION: String

MANIFEST_NONE

@JvmField

val MANIFEST_NONE: String

MANIFEST_OPERATION_OUTPUT

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_1)

@JvmField

val ~~MANIFEST_OPERATION_OUTPUT~~: String

MANIFEST_PERSISTED_QUERY

@JvmField

val MANIFEST_PERSISTED_QUERY: String

MODELS_OPERATION_BASED

@JvmField

val MODELS_OPERATION_BASED: String

MODELS_OPERATION_BASED_WITH_INTERFACES

@JvmField

val MODELS_OPERATION_BASED_WITH_INTERFACES: String

MODELS_RESPONSE_BASED

@JvmField

val MODELS_RESPONSE_BASED: String

Functions

buildCodegenOptions

fun buildCodegenOptions( targetLanguage: TargetLanguage? = null, decapitalizeFields: Boolean? = null, useSemanticNaming: Boolean? = null, generateMethods: List<GeneratedMethod>? = null, operationManifestFormat: String? = null, generateSchema: Boolean? = null, generatedSchemaName: String? = null, sealedClassesForEnumsMatching: List<String>? = null, generateAsInternal: Boolean? = null, addUnknownForEnums: Boolean? = null, addDefaultArgumentForInputObjects: Boolean? = null, generateFilterNotNull: Boolean? = null, generateInputBuilders: Boolean? = null, addJvmOverloads: Boolean? = null, requiresOptInAnnotation: String? = null, jsExport: Boolean? = null, generateModelBuilders: Boolean? = null, classesForEnumsMatching: List<String>? = null, generatePrimitiveTypes: Boolean? = null, nullableFieldStyle: JavaNullable? = null, generateFragmentImplementations: Boolean? = null, generateQueryDocument: Boolean? = null, packageName: String? = null, rootPackageName: String? = null): CodegenOptions

buildIrOptions

fun buildIrOptions( fieldsOnDisjointTypesMustMerge: Boolean? = null, decapitalizeFields: Boolean? = null, flattenModels: Boolean? = null, warnOnDeprecatedUsages: Boolean? = null, failOnWarnings: Boolean? = null, addTypename: String? = null, generateOptionalOperationVariables: Boolean? = null, alwaysGenerateTypesMatching: Set<String>? = null, codegenModels: String? = null): IrOptions

capitalizeFirstLetter

fun String.capitalizeFirstLetter(): String

A variation of String.capitalize that:

decapitalizeFirstLetter

fun String.decapitalizeFirstLetter(): String

A variation of String.decapitalize that:

findCodegenSchemaFile