Tasks

Other Methods

• + sharedCache

  The cache object is a singleton.

Access cache

• – cacheStatusForImageFromDocument:andPage:withSize:options:

  Get the cache status of a rendered image. options will ignore all entires except PSPDFCacheOptionSize*.

• – imageFromDocument:andPage:withSize:options:

  Get the image for a certain document page. Will first check the memory cache, then the disk cache and lastly queues a request to render. Returns the image instantly if the memory cache was filled, else will queue and call the delegate. If requireExactSize is set, images will either be downscaled or dynamically rendered. (There’s no point in upscaling)

Store into cache

• – saveImage:fromDocument:andPage:withReceipt:

  Caches the image in memory and disk for later re-use. PSPDFCache will decide at runtime if the image is worth saving into memory or just disk. (And disk will only be hit if the image is different)

Document preprocessing

• – cacheDocument:startAtPage:sizes:diskCacheStrategy:

  Starts caching the document. setting diskCacheStrategy to PSPDFDiskCacheStrategyEverything will pre-cache the whole document, and PSPDFDiskCacheStrategyNearPages will render a few pages around page.

• – stopCachingDocument:

  Stops all cache requests (render requests, queued disk writes) for the document.

Cache invalidation

• – cancelRequestForImageFromDocument:andPage:withSize:

  Cancels any open image request (disk load/render).

• – invalidateImageFromDocument:andPage:

  Allows to invalidate a single page in the document. This usually is called after an annotation changes (and thus the image needs to be re-rendered)

• – removeCacheForDocument:deleteDocument:error:

  Removes the whole cache (memory/disk) for document. Will cancel any open writes as well. Enable deleteDocument to remove the document and the associated metadata.

• – clearCache

  Clears the disk and memory cache.

Access internal caches

•   memoryCache

  Access the memory cache. Allows deeper customization of the amount of memory used.

  property
•   diskCache

  Access the disk cache. Allows deeper customization of the amount of disk space used.

  property

Settings

•   cacheDirectory

  Cache files are saved in a subdirectory of NSCachesDirectory. Defaults to “PSPDFKit/Pages”.

  property
•   diskCacheStrategy

  Defines the global disk cache strategy. Defaults to PSPDFDiskCacheStrategyEverything. If PSPDFDocument also defines a strategy, that one is priorized.

  property
•   thumbnailSize

  The size of the thumbnail images used in the grid view and those shown before the full-size versions are rendered. Defaults to (170, 220) on iPad and (85, 110) on iPhone.

  property
•   tinySize

  The size of the images used in the scrobble bar. Defaults to CGSizeMake(50, 65).

  property

Starting/Stopping

• – pauseCachingForService:

  Will pause queued cache requests on the render queue. For service use the class object that requests the pause.

• – resumeCachingForService:

  Will resume queued cache requests on the render queue. For service use the class object that requested the pause.

Delegate

• – addDelegate:

  Register a delegate to be notifiec of new cache load events.

• – removeDelegate:

  Deregisters a delegate.

Disk Cache Settings

•   useJPGFormat

  JPG is almost always faster, and uses less memory (<50% of a PNG, usually). Defaults to YES. If you have very text-like pages, you might want to set this to NO.

  property
•   JPGFormatCompression

  Compression strength for JPG. (PNG is lossless) The higher the compression, the larger the files and the slower is decompression. Defaults to 0.9. This will load the pdf and remove any jpg artifacts.

  property
•   allowImageResize

  Will allow image resizing instead of re-rendering to generate thumbnails. This is conditionally enabled for older devices. This is a tradeoff between performance or quality.

  property

Encryption/Decryption Handlers

•   decryptFromPathBlock

  Decrypt data from the path. PSPDFKit Annotate feature. If set to nil, the default implementation will be used.

  property
•   encryptDataBlock

  Encrypt mutable data. PSPDFKit Annotate feature. If set to nil, the default implementation will be used.

  property