API Docs for: 5.4.0-alpha.26+455b3fc5
Show:

CacheCapabilitiesManager Class

CacheCapabilitiesManager provides encapsulated API access to the minimal subset of the Store's functionality that Cache implementations should interact with. It is provided to the Store's createRecordDataFor and createCache hooks.

Cache implementations should not need more than this API provides.

This class cannot be directly instantiated.

Methods

disconnectRecord

(
  • identifier
)
public

Signal to the store that the specified record may be considered fully removed from the cache. Generally this means that not only does no data exist for the identified resource, no known relationships still point to it either.

Parameters:

getSchemaDefinitionService

() public

Provides access to the SchemaService instance for this Store instance.

The SchemaService can be used to query for information about the schema of a resource.

hasRecord

(
  • identifier
)
Boolean public

Use this method to determine if the Store has an instantiated record associated with an identifier.

Parameters:

  • identifier Object

Returns:

Boolean:

notifyChange

(
  • identifier
  • namespace
  • key
)
public

Notify subscribers of the NotificationManager that cache state has changed.

attributes and relationships do not require a key, but if one is specified it is assumed to be the name of the attribute or relationship that has been updated.

No other namespaces currently expect the key argument.

Parameters:

  • identifier StableRecordIdentifier
  • namespace 'attributes' | 'relationships' | 'identity' | 'errors' | 'meta' | 'state'
  • key String | Undefined

setRecordId

(
  • identifier;
  • id;
)
public

Update the id for the record corresponding to the identifier This operation can only be done for records whose id is null.

Parameters:

Properties

identifierCache

IdentifierCache public

Provides access to the IdentifierCache instance for this Store instance.

The IdentifierCache can be used to peek, generate or retrieve a stable unique identifier for any resource.

schema

Unknown public

Provides access to the SchemaService instance for this Store instance.

The SchemaService can be used to query for information about the schema of a resource.