apollo-api/com.apollographql.apollo3.api/Adapter

Adapter

interface Adapter<T>

An Adapter is responsible for adapting scalars between their Json and Kotlin representations.

It is used to

deserialize network responses
serialize variables
normalize models into records that can be stored in cache
deserialize records

Note: Adapters are called from multiple threads and implementations must be thread safe.

Inheritors

ApolloOptionalAdapter

ObjectAdapter

Functions

array

@JvmName(name = "-array")

inline fun <T> Adapter<T>.array(): Adapter<Array<T>>

Note that Arrays require their type to be known at compile time, so we construct an anonymous object with reference to function with reified type parameters as a workaround.

catchToNull

@JvmName(name = "-catchToNull")

fun <T> Adapter<T>.catchToNull(): Adapter<T?>

catchToResult

@JvmName(name = "-catchToResult")

fun <T> Adapter<T>.catchToResult(): Adapter<FieldResult<T>>

errorAware

@JvmName(name = "-errorAware")

fun <T> Adapter<T>.errorAware(): Adapter<T>

fromJson

abstract fun fromJson(reader: JsonReader, customScalarAdapters: CustomScalarAdapters): T

Deserializes the given Json to the expected Kotlin type.

list

@JvmName(name = "-list")

fun <T> Adapter<T>.list(): ListAdapter<T>

nullable

@JvmName(name = "-nullable")

fun <T : Any> Adapter<T>.nullable(): NullableAdapter<T>

obj

@JvmName(name = "-obj")

fun <T> Adapter<T>.obj(buffered: Boolean = false): ObjectAdapter<T>

optional

@JvmName(name = "-optional")

fun <T> Adapter<T>.~~optional~~(): PresentAdapter<T>

present

@JvmName(name = "-present")

fun <T> Adapter<T>.present(): PresentAdapter<T>

toJson

abstract fun toJson(writer: JsonWriter, customScalarAdapters: CustomScalarAdapters, value: T)

Serializes a Kotlin type into its equivalent Json representation.

toJsonString

@JvmName(name = "-toJson")

@JvmOverloads

fun <T> Adapter<T>.toJsonString(value: T, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, indent: String? = null): String