gqlclient/io.github.vincentvibe3.gqlclient.dsl/Field

Field

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

Represents a field to be queried

Constructors

Field

constructor(name: String, parent: QueryElement?)

Types

ArgumentType

enum ArgumentType : Enum<Field.ArgumentType>

Types that arguments can be

Properties

alias

var alias: String?

Alias for the field name

name

val name: String

Name of the field to be queried

parent

open override val parent: QueryElement?

Functions

addArg

fun addArg(name: String, variable: Variable)

Adds a variable as an argument to the field. This will automatically register the variable for use in the query or mutation.

fun addArg(name: String, value: Long)

fun addArg(name: String, typeName: String)

fun addArg(name: String, typeName: Long, type: Field.ArgumentType)

fun addArg(name: String, typeName: String, type: Field.ArgumentType)

Adds an argument to the field

equals

open operator override fun equals(other: Any?): Boolean

field

fun field(name: String, init: Field.() -> Unit = {}): Field

Creates and register a Field as a child of the current QueryElement

fragment

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

Create and register an inline fragment for use in the field

hashCode

open override fun hashCode(): Int

include

fun include(variable: Variable)

fun include(bool: Boolean)

Adds an include directive to the field

skip

fun skip(variable: Variable)

fun skip(bool: Boolean)

Adds an skip directive to the field

toString

open override fun toString(): String

Generates the GraphQL string for the field

typename

fun typename()

Gets the name of the current type of the current QueryElement. Equivalent to __typename.

useFragment

fun useFragment(fragment: Fragment)

Inserts a fragment into the field