Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IViewerContentKeyCacheManager

Class for managing the cached viewer content keys

Hierarchy

  • IViewerContentKeyCacheManager

Index

Methods

Methods

tryClearCacheForDocumentAndType

  • tryClearCacheForDocumentAndType(documentArtifactId: number, viewerType: RelativityViewerType, productionArtifactId?: number, fileId?: number): any

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

    deprecated

    Use tryClearCacheForQueueItemAndType instead.

    Parameters

    • documentArtifactId: number

      Document id of the cache entry to remove

    • viewerType: RelativityViewerType

      Relativity viewer type of the cache entry to remove

    • Optional productionArtifactId: number

      The artifact id of the production set

    • Optional fileId: number

      The file id of the RDO file

    Returns any

tryClearCacheForQueueItemAndType

  • 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

    • Optional productionArtifactId: number

      The artifact id of the production set

    • Optional fileId: number

      The file id of the RDO file

    Returns any