api/co.anitrend.retrofit.graphql.model

Package-level declarations

Types

object EmptyGraphQLVariables : GraphQLVariables

Sentinel type for operations that take no variables. Generated operation objects for no-variable queries implement GraphQLOperation via GraphQLNoVarOperation.

GraphQLDocumentRegistry

interface GraphQLDocumentRegistry

A registry that provides GraphQL document text and APQ hash for a given operation name.

GraphQLJson

interface GraphQLJson

Pluggable serialization abstraction for GraphQL request and response bodies.

GraphQLNoVarOperation

interface GraphQLNoVarOperation : GraphQLOperation<EmptyGraphQLVariables>

Convenience interface for operations that take no variables.

GraphQLOperation

interface GraphQLOperation<TVariables : GraphQLVariables>

Represents a statically-known GraphQL operation with generated metadata.

GraphQLRequest

data class GraphQLRequest<TVariables : GraphQLVariables>(val query: String, val operationName: String, val variables: TVariables? = null, val extensions: Map<String, Any?> = emptyMap())

A typed GraphQL request payload.

GraphQLResponseException

class GraphQLResponseException(val errors: List<GraphError>?) : RuntimeException

Thrown when a GraphQL response contains errors and the caller requires non-null data.

GraphQLVariables

interface GraphQLVariables

Marker interface for generated GraphQL variable classes.

Functions

mapData

inline fun <T, R> GraphContainer<T>.mapData(transform: (T) -> R): R?

Transforms GraphContainer.data with transform if present, or returns null.

requireData

fun <T> GraphContainer<T>.requireData(): T

Returns the non-null GraphContainer.data or throws GraphQLResponseException if the response contains errors.