Interface IEpubPublicationMetadata

Contains all metadata items extracted from a publication plus EPUB specific metadata (namely media overlays metadata and unique identifier).

interface IEpubPublicationMetadata {
    getAll(): IPublicationMetadataItem[];
    getIdentifiers(): IPublicationMetadataItem[];
    getLanguages(): IPublicationMetadataItem[];
    getMediaOverlayMetadata(): IMediaOverlayMetadata;
    getTitles(): IPublicationMetadataItem[];
    getUniqueIdentifier(): IPublicationMetadataItem;
    toJSON(): IEpubPublicationMetadataData;
}

Hierarchy (View Summary)

IPublicationMetadata
- IEpubPublicationMetadata

Methods

getAll

getAll(): IPublicationMetadataItem[]
Get a list of all available metadata items.

Returns IPublicationMetadataItem[]
Inherited from IPublicationMetadata.getAll

getIdentifiers

getIdentifiers(): IPublicationMetadataItem[]
Get a list of all publication identifiers.

Returns IPublicationMetadataItem[]
Inherited from IPublicationMetadata.getIdentifiers

getLanguages

getLanguages(): IPublicationMetadataItem[]
Get a list of all language metadata items.

Returns IPublicationMetadataItem[]
Inherited from IPublicationMetadata.getLanguages

getMediaOverlayMetadata

getMediaOverlayMetadata(): IMediaOverlayMetadata
Gets the metadata found in the OPF related to EPUB media overlays.

Returns IMediaOverlayMetadata

getTitles

getTitles(): IPublicationMetadataItem[]
Get a list of all titles of this publication.

Returns IPublicationMetadataItem[]
Inherited from IPublicationMetadata.getTitles

getUniqueIdentifier

getUniqueIdentifier(): IPublicationMetadataItem
The unique identifier for the publication, as defined by the "unique-identifier" attribute on the element in the OPF file.

Returns IPublicationMetadataItem

toJSON

toJSON(): IEpubPublicationMetadataData
Get all metadata items as a plain JSON object.

Returns IEpubPublicationMetadataData
Overrides IPublicationMetadata.toJSON