Interface IReaderPublicationData

Represents a serializable version of ReaderPublication, returned when calling ReaderPublication.toJSON();

interface IReaderPublicationData {
    availableContentPositionTimelineUnits: ContentPositionTimelineUnit[];
    availableSyncMediaFormats: SyncMediaFormat[];
    defaultLocatorUrl: string;
    sourcePublicationHashSignature: string;
    spine: IReaderDocumentData[];
}

Properties

availableContentPositionTimelineUnits

availableContentPositionTimelineUnits: ContentPositionTimelineUnit[]

The units of measure that can be used when creating ContentPositionTimeline objects using this publication.

See IEpubReaderPublication.createContentPositionTimeline() and IPdfReaderPublication.createContentPositionTimeline() for how to create ContentPositionTimeline objects.

availableSyncMediaFormats

availableSyncMediaFormats: SyncMediaFormat[]

The sync media formats available in this publication.

defaultLocatorUrl

defaultLocatorUrl: string

The base URL used when creating Locators pointing to content in this publication.

sourcePublicationHashSignature

sourcePublicationHashSignature: string

The generated hash signature of the source publication, intended to uniquely identify the source publication.

spine

spine: IReaderDocumentData[]

The ordered list of ReaderDocumentData instances that are part of this publication.