gqlclient/io.github.vincentvibe3.gqlclient.dsl

Package-level declarations

Types

Argument

data class Argument(val name: String, val types: List<String>) : QueryComponent

Represents an argument to a field in a query

Directive

data class Directive(type: Directive.DirectiveType, condition: String) : QueryComponent

Represents a directive for use in a field

Field

data class Field(val name: String, val parent: QueryElement?) : QueryElement

Represents a field to be queried

Fragment

data class Fragment(val name: String, type: String, val inline: Boolean) : QueryElement

Represents a fragment

FragmentUse

data class FragmentUse(val attachedFragment: Fragment, val parent: QueryElement?) : QueryElement

Represents a reference to a fragment in a field

Introspection

sealed interface Introspection : QueryComponent

Base Class for Introspection related components

Mutation

data class Mutation(val name: String) : QueryElement, Operation

Represents a GraphQL mutation Created using query

Operation

sealed interface Operation

Base class for operations to be done in GraphQL

Query

data class Query(val name: String) : QueryElement, Operation

Represents a GraphQL query Created using query

QueryComponent

interface QueryComponent

Base class of all components of a GraphQl query

QueryElement

sealed class QueryElement : QueryComponent

Represents a component in a query that has children

SchemaIntrospection

class SchemaIntrospection(val parent: QueryElement?) : QueryElement, Introspection

Represents a __schema from the GraphQL introspection API. Allows getting information on the schema.

TypeIntrospection

data class TypeIntrospection(val type: String, val parent: QueryElement?) : QueryElement, Introspection

Represents a __type from the GraphQL introspection API.

TypenameIntrospection

object TypenameIntrospection : Introspection

Represents a __typename from the GraphQL introspection API

Variable

class Variable(name: String, val type: String) : QueryComponent

Represents a variable declaration in a query.

Functions

fragment

fun fragment(name: String, type: String, init: Fragment.() -> Unit): Fragment

Creates a Fragment that can be registered in a Query for use

mutation

fun mutation(name: String = "", init: Mutation.() -> Unit): Mutation

Creates a Mutation

query

fun query(name: String = "", init: Query.() -> Unit): Query

Creates a Query