apollo-normalized-cache-api/com.apollographql.apollo3.cache.normalized.api/Record

Record

class Record(val key: String, val fields: Map<String, Any?>, val mutationId: Uuid? = null) : Map<String, Any?>

A normalized entry that corresponds to a response object. Object fields are stored if they are a GraphQL Scalars. If a field is a GraphQL Object a CacheKey will be stored instead.

Constructors

Record

constructor(key: String, fields: Map<String, Any?>, mutationId: Uuid?, date: Map<String, Long?>)

constructor(key: String, fields: Map<String, Any?>, mutationId: Uuid? = null)

Types

Companion

object Companion

Properties

date

@ApolloExperimental

var date: Map<String, Long?>?

entries

open override val entries: Set<Map.Entry<String, Any?>>

fields

val fields: Map<String, Any?>

a list of fields. Values can be

key

val key: String

keys

open override val keys: Set<String>

mutationId

val mutationId: Uuid? = null

size

open override val size: Int

sizeInBytes

val sizeInBytes: Int

values

open override val values: Collection<Any?>

Functions

containsKey

open override fun containsKey(key: String): Boolean

containsValue

open override fun containsValue(value: Any?): Boolean

fieldKeys

fun fieldKeys(): Set<String>

Returns a set of all field keys. A field key incorporates any GraphQL arguments in addition to the field name.

get

open operator override fun get(key: String): Any?

isEmpty

open override fun isEmpty(): Boolean

mergeWith

fun mergeWith(newRecord: Record): Pair<Record, Set<String>>

@ApolloExperimental

fun mergeWith(newRecord: Record, newDate: Long?): Pair<Record, Set<String>>

Returns a merge result record and a set of field keys which have changed, or were added. A field key incorporates any GraphQL arguments in addition to the field name.

referencedFields

fun referencedFields(): List<CacheKey>

Returns the list of referenced cache fields