normalized-cache-incubating/com.apollographql.cache.normalized.api/Record

Record

class Record(val key: String, val fields: Map<String, RecordValue>, 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?, metadata: Map<String, Map<String, ApolloJsonElement>>)

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

Types

Companion

object Companion

Properties

entries

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

fields

val fields: Map<String, RecordValue>

a list of fields. Values can be

key

val key: String

keys

open override val keys: Set<String>

metadata

var metadata: Map<String, Map<String, ApolloJsonElement>>

Arbitrary metadata that can be attached to each field.

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

expirationDate

fun Record.expirationDate(field: String): Long?

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>>

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.

receivedDate

fun Record.receivedDate(field: String): Long?

referencedFields

fun referencedFields(): List<CacheKey>

Returns the list of referenced cache fields

withDates

fun Record.withDates(receivedDate: String?, expirationDate: String?): Record