Documentation / @ember-data/store / types / CacheCapabilitiesManager

type CacheCapabilitiesManager = object;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:19

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 createCache hook.

Cache implementations should not need more than this API provides.

This class cannot be directly instantiated.

CacheCapabilitiesManager

Properties

identifierCache

identifierCache: IdentifierCache;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:31

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

schema: SchemaService;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:57

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.

Methods

disconnectRecord()

disconnectRecord(identifier): void;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:78

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

identifier

StableRecordIdentifier

Returns

void

---

getSchemaDefinitionService()

getSchemaDefinitionService(): SchemaService;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:45

DEPRECATED - use the schema property

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.

Returns

SchemaService

Deprecated

---

hasRecord()

hasRecord(identifier): boolean;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:88

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

Parameters

identifier

StableRecordIdentifier

Returns

boolean

---

notifyChange()

Call Signature

notifyChange(
   identifier, 
   namespace, 
   key): void;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:103

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

"added" | "removed"

key

null

Returns

void

Call Signature

notifyChange(
   identifier, 
   namespace, 
   key): void;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:104

Parameters

identifier

StableDocumentIdentifier

namespace

"added" | "removed" | "updated"

key

null

Returns

void

Call Signature

notifyChange(
   identifier, 
   namespace, 
   key): void;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:105

Parameters

identifier

StableRecordIdentifier

namespace

NotificationType

key

null | string

Returns

void

Call Signature

notifyChange(
   identifier, 
   namespace, 
   key): void;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:106

Parameters

identifier

StableRecordIdentifier | StableDocumentIdentifier

namespace

NotificationType

key

null | string

Returns

void

---

setRecordId()

setRecordId(identifier, id): void;

Defined in: packages/store/src/-types/q/cache-capabilities-manager.ts:67

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

Parameters

identifier

StableRecordIdentifier

id

string

Returns

void