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

GQLDocument

data class GQLDocument(val definitions: List<GQLDefinition>, val filePath: String?) : 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

fun GQLDocument(definitions: List<GQLDefinition>, filePath: String?)

Types

object Companion

Functions

copyWithNewChildrenInternal

open override fun copyWithNewChildrenInternal(container: NodeContainer): GQLNode

Internal-only. Copies this code using the given children

open override fun writeInternal(writer: SDLWriter)

Internal-only. Copies this code using the given children

Properties

open override val children: List<GQLDefinition>

The children of this node.

val definitions: List<GQLDefinition>

val filePath: String?

open override val sourceLocation: SourceLocation

Extensions

validateAsExecutable

@ApolloExperimental

fun GQLDocument.validateAsExecutable(schema: Schema, fieldsOnDisjointTypesMustMerge: Boolean = true): GQLResult<List<GQLDefinition>>

Validates the given document as an executable document.

validateAsSchema

@ApolloExperimental

fun GQLDocument.validateAsSchema(): GQLResult<Schema>

Validate the given document as a schema:

validateAsSchemaAndAddApolloDefinition

fun GQLDocument.validateAsSchemaAndAddApolloDefinition(): GQLResult<Schema>

withApolloDefinitions

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_3_1)

~~fun~~ GQLDocument.~~withApolloDefinitions~~(): GQLDocument

withBuiltinDefinitions

fun GQLDocument.withBuiltinDefinitions(): GQLDocument

withBuiltinDirectives

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_3_1)

~~fun~~ GQLDocument.~~withBuiltinDirectives~~(): GQLDocument

withoutBuiltinDefinitions

fun GQLDocument.withoutBuiltinDefinitions(): GQLDocument

withoutBuiltinDirectives

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_3_1)

~~fun~~ GQLDocument.~~withoutBuiltinDirectives~~(): GQLDocument