Metadata class

https://readium.org/webpub-manifest/schema/metadata.schema.json

@param readingProgression WARNING: This contains the reading progression as declared in the publication, so it might be AUTO. To lay out the content, use effectiveReadingProgression to get the calculated reading progression from the declared direction and the language. @param otherMetadata Additional metadata for extensions, as a JSON dictionary.

Mixed-in types
  • JSONable
Available extensions

Constructors

Metadata({String? identifier, String? type, required LocalizedString localizedTitle, LocalizedString? localizedSubtitle, DateTime? modified, DateTime? published, List<String> languages = const [], LocalizedString? localizedSortAs, List<Subject> subjects = const [], List<Contributor> authors = const [], List<Contributor> contributors = const [], List<Contributor> translators = const [], List<Contributor> editors = const [], List<Contributor> artists = const [], List<Contributor> illustrators = const [], List<Contributor> letterers = const [], List<Contributor> pencilers = const [], List<Contributor> colorists = const [], List<Contributor> inkers = const [], List<Contributor> narrators = const [], List<Contributor> publishers = const [], List<Contributor> imprints = const [], String? description, double? duration, int? numberOfPages, Map<String, List<Collection>>? belongsTo, List<Collection> belongsToCollections = const [], List<Collection> belongsToSeries = const [], ReadingProgression readingProgression = ReadingProgression.auto, Presentation? rendition, Map<String, dynamic> otherMetadata = const {}})

Properties

artists → List<Contributor>
final
authors → List<Contributor>
final
belongsTo → Map<String, List<Collection>>
final
belongsToCollections → List<Collection>
final
belongsToSeries → List<Collection>
final
colorists → List<Contributor>
final
contributors → List<Contributor>
final
description → String?
final
duration → double?
final
editors → List<Contributor>
final
effectiveReadingProgression → ReadingProgression
no setter
hashCode → int
The hash code for this object.
no setterinherited
identifier → String?
An URI used as the unique identifier for this Publication.
final
illustrators → List<Contributor>
final
imprints → List<Contributor>
final
inkers → List<Contributor>
final
language → String?
(Nullable) First language in the publication.
no setter
languages → List<String>
Languages used in the publication.
final
letterers → List<Contributor>
final
localizedSortAs → LocalizedString?
Alternative title to be used for sorting the publication in the library.
final
localizedSubtitle → LocalizedString?
final
localizedTitle → LocalizedString
final
modified → DateTime?
final
narrators → List<Contributor>
final
numberOfPages → int?
Number of pages in the publication, if available.
final
otherMetadata → Map<String, dynamic>
final
pencilers → List<Contributor>
final
presentation → Presentation

Available on Metadata, provided by the PresentionMetadataExtension extension

no setter
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setter
published → DateTime?
final
publishers → List<Contributor>
final
readingProgression → ReadingProgression
Direction of the Publication reading progression.
final
rendition → Presentation?
Information about the contents rendition.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sortAs → String?
Returns the default translation string for the localizedSortAs.
no setter
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
subjects → List<Subject>
Themes/subjects of the publication.
final
title → String
Returns the default translation string for the localizedTitle.
no setter
translators → List<Contributor>
final
type → String?
final

Methods

copy({String? identifier, String? type, LocalizedString? localizedTitle, LocalizedString? localizedSubtitle, DateTime? modified, DateTime? published, List<String>? languages, LocalizedString? localizedSortAs, List<Subject>? subjects, List<Contributor>? authors, List<Contributor>? publishers, List<Contributor>? contributors, List<Contributor>? translators, List<Contributor>? editors, List<Contributor>? artists, List<Contributor>? illustrators, List<Contributor>? letterers, List<Contributor>? pencilers, List<Contributor>? colorists, List<Contributor>? inkers, List<Contributor>? narrators, List<Contributor>? imprints, String? description, double? duration, int? numberOfPages, Map<String, List<Collection>>? belongsTo, ReadingProgression? readingProgression, Presentation? rendition, Map<String, dynamic>? otherMetadata}) → Metadata
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes a Metadata to its RWPM JSON representation.
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited
operator [](String key) → dynamic
Syntactic sugar to access the otherMetadata values by subscripting Metadata directly. metadata["layout"] == metadata.otherMetadata["layout"]

Static Methods

fromJson(Map<String, dynamic>? json, {LinkHrefNormalizer normalizeHref = linkHrefNormalizerIdentity}) → Metadata?
Parses a Metadata from its RWPM JSON representation.