Properties class

Mixed-in types
  • JSONable
Available extensions

Constructors

Properties({Map<String, dynamic>? otherProperties})

Properties

availability Availability?

Available on Properties, provided by the OpdsPropertiesExtension extension

Indicated the availability of a given resource.
no setter
clipped bool?

Available on Properties, provided by the PresentionPropertiesExtension extension

Specifies whether or not the parts of a linked resource that flow out of the viewport are clipped.
no setter
contains Set<String>
Identifies content contained in the linked resource, that cannot be strictly identified using a media type.
no setter
copies Copies?

Available on Properties, provided by the OpdsPropertiesExtension extension

Library-specific feature that contains information about the copies that a library has acquired.
no setter
encryption Encryption?
(Nullable) Indicates that a resource is encrypted/obfuscated and provides relevant information for decryption.
no setter
fit PresentationFit?

Available on Properties, provided by the PresentionPropertiesExtension extension

Suggested method for constraining a resource inside the viewport.
no setter
hashCode int
The hash code for this object.
no setterinherited
holds Holds?

Available on Properties, provided by the OpdsPropertiesExtension extension

Library-specific features when a specific book is unavailable but provides a hold list.
no setter
indirectAcquisitions List<Acquisition>

Available on Properties, provided by the OpdsPropertiesExtension extension

Indirect acquisition provides a hint for the expected media type that will be acquired after additional steps.
no setter
layout EpubLayout?
(Nullable) Hints how the layout of the resource should be presented.
no setter
numberOfItems int?

Available on Properties, provided by the OpdsPropertiesExtension extension

Provides a hint about the expected number of items returned.
no setter
orientation PresentationOrientation?
(Nullable) Suggested orientation for the device when displaying the linked resource.
no setter
orientation PresentationOrientation?

Available on Properties, provided by the PresentionPropertiesExtension extension

Suggested orientation for the device when displaying the linked resource.
no setter
otherProperties Map<String, dynamic>
getter/setter pair
overflow PresentationOverflow?
(Nullable) Suggested method for handling overflow while displaying the linked resource.
no setter
overflow PresentationOverflow?

Available on Properties, provided by the PresentionPropertiesExtension extension

Suggested method for handling overflow while displaying the linked resource.
no setter
page PresentationPage?
(Nullable) Indicates how the linked resource should be displayed in a reading environment that displays synthetic spreads.
no setter
page PresentationPage?

Available on Properties, provided by the PresentionPropertiesExtension extension

Indicates how the linked resource should be displayed in a reading environment that displays synthetic spreads.
no setter
price Price?

Available on Properties, provided by the OpdsPropertiesExtension extension

The price of a publication is tied to its acquisition link.
no setter
props List<Object>
The list of properties that will be used to determine whether two instances are equal.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
spread PresentationSpread?
(Nullable) Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.
no setter
spread PresentationSpread?

Available on Properties, provided by the PresentionPropertiesExtension extension

Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.
no setter
stringify bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited

Methods

add(Map<String, dynamic> properties) Properties
copy({Map<String, dynamic>? otherProperties}) Properties
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Serializes a Properties 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 name) → dynamic

Static Methods

fromJSON(Map<String, dynamic>? json) Properties
Creates a Properties from its RWPM JSON representation.