Options
All
  • Public
  • Public/Protected
  • All
Menu

Allows management of a ReaderPublication's storage state, such as 'localStorage' for EPUB. This allows applications to save and restore the IReaderPublicationStorageState across reading-sessions and devices.

Hierarchy

  • IReaderPublicationStorage

Index

Methods

getStorageSizeLimit

  • getStorageSizeLimit(): number
  • Get the size limit of the publication storage. This may be in bytes or character code points, depending on the format adapter and its underlying storage API that it provides to content documents.

    Thus, the size of the serialized state of the storage may become much larger than this size depending on the string encoding used when serializing the data.

    Returns number

getStorageState

setStorageSizeLimit

  • setStorageSizeLimit(sizeLimit: number): void
  • Set the size limit of the publication storage. This may be in bytes or character code points, depending on the format adapter and its underlying storage API that it provides to content documents.

    Thus, the size of the serialized state of the storage may become much larger than this size depending on the string encoding used when serializing the data.

    Parameters

    • sizeLimit: number

    Returns void

setStorageState

  • Sets the storage state for this IReaderPublication. This method should be called BEFORE rendering the publication using a ReaderView.

    Parameters

    Returns void

Generated using TypeDoc