In This Topic ▼

cacheStatus Property

Summary

The cache status of this document.

Syntax

TypeScript

JavaScript

Object.defineProperty(LEADDocument.prototype, 'cacheStatus', 
   get: function(), 
   set: function(value) 
)

cacheStatus: DocumentCacheStatus;

Property Value

The cache status of this document. Default value is DocumentCacheStatus.NotSynced.

Remarks

The value of CacheStatus will be DocumentCacheStatus.NotSynced when any part of the document has not been updated into the cache. This is the default value when a document is first loaded from a URL / disk file / stream or, when uploaded or when created through the factory. When the document is saved into the cache using SaveToCache, the value of CacheStatus will be set to DocumentCacheStatus.Synced and the timestamp of the operation is stored in LastCacheSyncTime.

If the document is modified by adding / removing pages or when the content of any page is changed, then the value of CacheStatus will be to DocumentCacheStatus.NotSynced automatically.

Requirements

Target Platforms