NAME
XML::OPDS::Navigation - Navigation elements for OPDS feeds
SETTERS/ACCESSORS
The all are read-write
prefix
If provided, every uri will have this string prepended, so you can just pass URIs like '/path/to/file' and have them consistently turned to 'http://myserver.org/path/to/file' if you set this to 'http://myserver.org'. See also XML::OPDS prefix method.
href
Required. The URI of the resource. If prefix is provided it is prepended on output.
id
rel
Defaults to subsection. Permitted values: self, start, up, subsection, search.
Additionally:
new and popular will expand to http://opds-spec.org/sort/new and http://opds-spec.org/sort/popular as per spec paragraph 7.4.1.
Acquisition Feeds using the "http://opds-spec.org/sort/new" relation SHOULD be ordered with the most recent items first. Acquisition Feeds using the " http://opds-spec.org/sort/popular" relation SHOULD be ordered with the most popular items first.
featured will expand to http://opds-spec.org/featured as per 7.4.2
recommended will expand to http://opds-spec.org/recommended as per 7.4.3
shelf will expand to http://opds-spec.org/shelf and subscriptions to http://opds-spec.org/subscriptions.
crawlable will expand to http://opds-spec.org/crawlable.
This list is a work in progress and probably incomplete.
Facets are not supported yet (patches welcome). Client support for facets is unclear. https://en.wikipedia.org/wiki/OPDS.
title
acquistion
Boolean, default to false. Indicates that the href is a leaf feed with acquisition entries.
description
HTML allowed.
updated
A DateTime object with the time of last update.
prefix
METHODS
The are mostly internals and used by XML::OPDS
link_type
Depend if acquisition is true of false.
as_link
The navigation as XML::Atom::Link object.
identifier
Return the id or the URI.
relationship
[INTERNAL] Resolve the rel shortcuts.
as_entry
The navigation as XML::Atom::Entry object.