apollo-ast/com.apollographql.apollo.ast/GQLDocument

GQLDocument

class GQLDocument(val definitions: List<GQLDefinition>, val sourceLocation: SourceLocation?) : GQLNode

The top level node in a GraphQL document. This can be a schema document or an executable document (or something else if need be)

See parseAsGQLDocument for how to obtain a GQLDocument.

Constructors

GQLDocument

constructor(definitions: List<GQLDefinition>, sourceLocation: SourceLocation?)

Types

Companion

object Companion

Properties

children

open override val children: List<GQLDefinition>

The children of this node.

definitions

val definitions: List<GQLDefinition>

sourceLocation

open override val sourceLocation: SourceLocation?

Functions

copy

fun copy(definitions: List<GQLDefinition> = this.definitions, sourceLocation: SourceLocation? = this.sourceLocation): GQLDocument

copyWithNewChildrenInternal

open override fun copyWithNewChildrenInternal(container: NodeContainer): GQLNode

Internal-only. Copies this code using the given children

mergeExtensions

@ApolloExperimental

fun GQLDocument.mergeExtensions(mergeOptions: MergeOptions = MergeOptions.Default): GQLResult<GQLDocument>

toFullSchemaGQLDocument

@ApolloExperimental

fun GQLDocument.toFullSchemaGQLDocument(): GQLDocument

Returns a "full schema" document containing the built-in definitions supported by Apollo Kotlin.

toIntrospectionSchema

fun GQLDocument.toIntrospectionSchema(): ApolloIntrospectionSchema

TODO: should this be deprecated? See also the comment in WSchema. It's not clear what value there is in converting from SDL to JSON.

toMergedGQLDocument

@ApolloExperimental

fun GQLDocument.toMergedGQLDocument(mergeOptions: MergeOptions = MergeOptions.Default): GQLDocument

toSchema

fun GQLDocument.toSchema(): Schema

toSDL

@ApolloExperimental

fun GQLDocument.toSDL(indent: String = " ", includeBuiltInScalarDefinitions: Boolean = false): String

Outputs a schema document to SDL. For executable documents, use toUtf8()

toUtf8

fun GQLNode.toUtf8(indent: String = " "): String

@ApolloExperimental

fun GQLNode.toUtf8(sink: BufferedSink, indent: String = " ")

fun GQLNode.toUtf8(file: File, indent: String = " ")

transform

@ApolloExperimental

fun GQLNode.transform(transformer: NodeTransformer): GQLNode?

validateAsExecutable

@ApolloExperimental

fun GQLDocument.validateAsExecutable(schema: Schema): ExecutableValidationResult

Validates the given document as an executable document.

validateAsSchema

@ApolloExperimental

fun GQLDocument.validateAsSchema(): GQLResult<Schema>

Validate the given document as a schema:

@ApolloExperimental

fun GQLDocument.validateAsSchema(validationOptions: SchemaValidationOptions): GQLResult<Schema>

validateAsSchemaAndAddApolloDefinition

fun GQLDocument.validateAsSchemaAndAddApolloDefinition(): GQLResult<Schema>

withBuiltinDefinitions

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_1_2)

fun GQLDocument.~~withBuiltinDefinitions~~(): GQLDocument

Add built-in definitions supported by Apollo Kotlin to the GQLDocument

withoutBuiltinDefinitions

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun GQLDocument.~~withoutBuiltinDefinitions~~(): GQLDocument

writeInternal

open override fun writeInternal(writer: SDLWriter)

Internal-only. Copies this code using the given children