android-components / mozilla.components.browser.state.state / ReaderState

ReaderState

data class ReaderState (source)

Value type that represents the state of reader mode/view.

Constructors

Name Summary
<init> ReaderState(readerable: Boolean = false, active: Boolean = false, checkRequired: Boolean = false, connectRequired: Boolean = false, baseUrl: String? = null, activeUrl: String? = null)
Value type that represents the state of reader mode/view.

Properties

Name Summary
active val active: Boolean
whether or not reader view is active.
activeUrl val activeUrl: String?
the URL of the page currently displayed in reader view.
baseUrl val baseUrl: String?
the base URL of the reader view extension page.
checkRequired val checkRequired: Boolean
whether or not a readerable check is required for the current page.
connectRequired val connectRequired: Boolean
whether or not a new connection to the reader view content script is required.
readerable val readerable: Boolean
whether or not the current page can be transformed to be displayed in a reader view.

Extension Functions

Name Summary
loadResourceAsString fun Any.loadResourceAsString(path: String): String
Loads a file from the resources folder and returns its content as a string object.