Skip to main content

SeriesReaderSettingsResponse

A user's content-setting overrides for one series, and what lies beneath them.

Sparse: an override field is absent when the user has not set it, and the reader inherits instead. For reading direction that means the series metadata and then the library default.

The inherited* fields report that lower value whether or not an override is present. They exist because a book response carries the direction already resolved, so a client holding an override cannot otherwise see what dropping it would fall back to, and cannot word the offer to drop it.

Settings that describe the device rather than the content, such as fit mode and page layout, are deliberately not here. They belong to the screen in front of the reader, not to the file, and each client keeps its own.

inheritedReadingDirectionReadingDirection

Direction this user would inherit with no override of their own.

Read-only, and absent when no layer holds a usable value.

Possible values: [ltr, rtl, ttb, webtoon]

inheritedReadingDirectionSourceInheritedFrom

Which layer [Self::inherited_reading_direction] came from.

Always present and absent together with it, because the two are set from one resolved pair.

Possible values: [series, library]

readingDirectionReadingDirection

Reading direction for this series, for this user only

Possible values: [ltr, rtl, ttb, webtoon]

SeriesReaderSettingsResponse
{
"inheritedReadingDirection": "ltr",
"inheritedReadingDirectionSource": "series",
"readingDirection": "ltr"
}