Interface: IViewerContentKeyCacheManager

Class for managing the cached viewer content keys

Methods

tryClearCacheForDocumentAndType()

tryClearCacheForDocumentAndType(documentArtifactId, viewerType, productionArtifactId?, fileId?, productionType?): any

Tries to remove the viewer content key with matching document artifact ID and RelativityViewerType from both the in-memory cache and session storage

Parameters

documentArtifactId: number

Document id of the cache entry to remove

viewerType: RelativityViewerType

Relativity viewer type of the cache entry to remove

productionArtifactId?: number

The artifact id of the production set

fileId?: number

The file id of the RDO file

productionType?: ProductionType

The type of production for the document data

Returns

any

Deprecated

Use tryClearCacheForQueueItemAndType instead.


tryClearCacheForQueueItemAndType()

tryClearCacheForQueueItemAndType(queueItem, viewerType, productionArtifactId?, fileId?, productionType?): any

Tries to remove the viewer content key with matching queue item identifier and RelativityViewerType from both the in-memory cache and session storage

Parameters

queueItem: IQueueItem

Queue item identifier of the item to remove from the cache

viewerType: RelativityViewerType

Relativity viewer type of the cache entry to remove

productionArtifactId?: number

The artifact id of the production set

fileId?: number

The file id of the RDO file

productionType?: ProductionType

The type of production for the document data

Returns

any