EpubPackage class

EpubPackage class

Represents metadata in a EPUB e-book.

Inheritance: EpubPackage → CustomPackage → MetadataPackage

The EpubPackage type exposes the following members:

Properties

Property Description
metadata_type Gets the metadata type.
keys Gets a collection of the metadata property names.
property_descriptors Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count Gets the number of metadata properties.
image_cover Gets the image cover as an array of bytes.
version Gets the EPUB version.
unique_identifier Gets the package unique identifier.
abstract Gets or sets a summary of the resource.
access_rights Gets or sets the information about who access the resource or an indication of its security status.
accrual_method Gets or sets the method by which items are added to a collection.
accrual_periodicity Gets or sets the frequency with which items are added to a collection.
accrual_policy Gets or sets the policy governing the addition of items to a collection.
alternative Gets or sets an alternative name for the resource.
audience Gets or sets a class of agents for whom the resource is intended or useful.
available Gets or sets the date that the resource became or will become available.
bibliographic_citation Gets or sets a bibliographic reference for the resource.
conforms_to Gets or sets an established standard to which the described resource conforms.
contributor Gets or sets an entity responsible for making contributions to the resource.
coverage Gets or sets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant.
created Gets or sets the date of creation of the resource.
creator Gets or sets an entity responsible for making the resource.
date Gets or sets a point or period of time associated with an event in the lifecycle of the resource.
date_accepted Gets or sets the date of acceptance of the resource.
date_copyrighted Gets or sets the date of copyright of the resource.
date_submitted Gets or sets the date of submission of the resource.
description Gets or sets an account of the resource.
education_level Gets or sets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.
extent Gets or sets the size or duration of the resource.
format Gets or sets the file format, physical medium, or dimensions of the resource.
has_format Gets or sets a related resource that is substantially the same as the pre-existing described resource, but in another format.
has_part Gets or sets a related resource that is included either physically or logically in the described resource.
has_version Gets or sets a related resource that is a version, edition, or adaptation of the described resource.
identifier Gets or sets an unambiguous reference to the resource within a given context.
instructional_method Gets or sets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.
is_format_of Gets or sets a pre-existing related resource that is substantially the same as the described resource, but in another format.
is_part_of Gets or sets a related resource in which the described resource is physically or logically included.
is_referenced_by Gets or sets a related resource that references, cites, or otherwise points to the described resource.
is_replaced_by Gets or sets a related resource that supplants, displaces, or supersedes the described resource.
is_required_by Gets or sets a related resource that requires the described resource to support its function, delivery, or coherence.
issued Gets or sets the date of formal issuance of the resource.
is_version_of Gets or sets a related resource of which the described resource is a version, edition, or adaptation.
language Gets or sets the language of the resource.
license Gets or sets a legal document giving official permission to do something with the resource.
mediator Gets or sets an entity that mediates access to the resource.
medium Gets or sets the material or physical carrier of the resource.
modified Gets or sets the date on which the resource was changed.
provenance Gets or sets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.
publisher Gets or sets an entity responsible for making the resource available.
references Gets or sets a related resource that is referenced, cited, or otherwise pointed to by the described resource.
relation Gets or sets a related resource.
replaces Gets or sets a related resource that is supplanted, displaced, or superseded by the described resource.
requires Gets or sets a related resource that is required by the described resource to support its function, delivery, or coherence.
rights Gets or sets the information about rights held in and over the resource.
rights_holder Gets or sets a person or organization owning or managing rights over the resource.
source Gets or sets a related resource from which the described resource is derived.
spatial Gets or sets the spatial characteristics of the resource.
subject Gets or sets a topic of the resource.
table_of_contents Gets or sets a list of subunits of the resource.
temporal Gets or sets the temporal characteristics of the resource.
title Gets or sets a name given to the resource.
type Gets or sets the nature or genre of the resource.
valid Gets or sets the date (often a range) of validity of a resource.

Methods

Method Description
contains(self, property_name) Determines whether the package contains a metadata property with the specified name.
find_properties(self, specification) Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.
update_properties(self, specification, value) Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.
remove_properties(self, specification) Removes metadata properties satisfying a specification.
add_properties(self, specification, value) Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
set_properties(self, specification, value) Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.
sanitize(self) Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

Remarks

Learn more | | |

See Also

EpubRootPackage class