Skip to content

Get viewer settings

GET
/api/v1/books/{bookId}/viewer-setting
curl --request GET \
--url 'http://127.0.0.1:58259/api/v1/books/1/viewer-setting?bookFileId=1'

Retrieve viewer settings for a specific book file.

bookId
required
integer format: int64

ID of the book

bookFileId
required
integer format: int64

ID of the book file

Viewer settings returned successfully

Media type */*

Viewer settings to update

object
pdfSettings
object
bookId
integer format: int64
zoom
string
spread
string
isDarkTheme
boolean
newPdfSettings
object
bookId
integer format: int64
pageSpread
string
Allowed values: EVEN ODD
pageViewMode
string
Allowed values: SINGLE_PAGE TWO_PAGE
backgroundColor
string
Allowed values: GRAY BLACK WHITE
fitMode
string
Allowed values: ACTUAL_SIZE FIT_PAGE FIT_WIDTH FIT_HEIGHT AUTO
scrollMode
string
Allowed values: PAGINATED INFINITE
ebookSettings
object
bookId
integer format: int64
userId
integer format: int64
fontFamily
string
fontSize
integer format: int32
gap
number format: float
hyphenate
boolean
isDark
boolean
justify
boolean
lineHeight
number format: float
maxBlockSize
integer format: int32
maxColumnCount
integer format: int32
maxInlineSize
integer format: int32
theme
string
flow
string
cbxSettings
object
bookId
integer format: int64
pageSpread
string
Allowed values: EVEN ODD
pageViewMode
string
Allowed values: SINGLE_PAGE TWO_PAGE
fitMode
string
Allowed values: ACTUAL_SIZE FIT_PAGE FIT_WIDTH FIT_HEIGHT AUTO
scrollMode
string
Allowed values: PAGINATED INFINITE LONG_STRIP
backgroundColor
string
Allowed values: GRAY BLACK WHITE