apollo-api/com.apollographql.apollo.api/RequestParameters

RequestParameters

class RequestParameters

The request parameters.

See https://graphql.github.io/graphql-over-http/draft/#sec-Request-Parameters

Constructors

RequestParameters

constructor(query: String?, operationName: String, variables: Map<String, ApolloJsonElement?>, extensions: Map<String, ApolloJsonElement?>, uploads: Map<String, Upload>)

Properties

val extensions: Map<String, ApolloJsonElement?>

additional parameters for the request.

@ApolloExperimental

val onError: OnError?

val operationName: String

the name of the operation to execute.

val query: String?

the GraphQL executable document to execute. May be null for persisted queries.

val uploads: Map<String, Upload>

files to upload.

val variables: Map<String, ApolloJsonElement?>

the variables to use for the query.

Functions

fun RequestParameters.toByteString(): ByteString

Turns the RequestParameters into a ByteString

fun RequestParameters.toHttpBody(): HttpBody

Turns the RequestParameters into a HttpBody

fun RequestParameters.toMap(): Map<String, Any?>

Turns the RequestParameters into a Map