Package-level declarations

Types

Link copied to clipboard

Interface for providing custom action bars for views. Implementing this is optional.

Link copied to clipboard
Link copied to clipboard

Class for presenting alerts present in the fi.richie.common.appconfig.Appconfig.

Link copied to clipboard

Appconfig data callback. Use this if you need to perform your own parsing from the appconfig.

Link copied to clipboard

This object mostly exists for Appconfig needs outside booklibraryui. In booklibraryui, you should use Provider.appconfigStore instead.

Link copied to clipboard
interface ArticleOpener

An interface to be implemented by the host application for handling article open requests from the SDK.

Link copied to clipboard
class AudioPlayerGateway(bookLibraryController: BookLibraryController) : PlayerEventListener

This object provides the current state of the audio player (if any exists), and also updates.

Link copied to clipboard

Interface for providing binding override adapters. Use a custom override adapter if overridden bindings are incompatible with data binding. (i.e. they crash)

Link copied to clipboard

Interface for providing optional descriptions to the book covers shown in book lists etc.

Link copied to clipboard
class BookLibraryController(context: Context, extraCompositions: Collection<String> = emptyList(), adManager: AdManager, tokenProvider: TokenProvider, editionsBooksContext: EditionsBooksContext? = null, bookOpening: BookOpening? = null, readingListHost: ReadingListHost? = null, articleOpener: ArticleOpener? = null, navigationDelegate: LibraryNavigationDelegate? = null, coverOverlayProvider: BookCoverOverlayProvider? = null, categoryListIconProvider: CategoryListIconProvider? = null, bindingOverrideAdapterFactory: BindingOverrideAdapterFactory? = null, fontProvider: DataBindingValueProvider.Fonts? = null, colorProvider: DataBindingValueProvider.Colors? = null, appdataNetworking: AppdataNetworking? = null, analyticsEventListener: BooksAnalyticsEventListener? = null)

The main entry point for the Book Library UI SDK.

Link copied to clipboard
data class BookLibraryUiConfiguration(val topLevelTitle: String? = null, val libraryFilters: List<Filter>? = null, val showBlurredDetailBackground: Boolean? = null, val defaultCoverSize: IntSize? = null)

Configuration class for various UI bits.

Link copied to clipboard
interface BookOpening

Callbacks for when a book will open and has been opened.

Link copied to clipboard

The policy to pass back to the callback in the BookOpening.onWillOpenBook function.

Link copied to clipboard

Description of a library entry's media type.

Link copied to clipboard

Interface for providing icons for items in the list of categories.

Link copied to clipboard

Class for following the state of the content feed.

Link copied to clipboard

The listener for the content feed state.

Link copied to clipboard
typealias EventLoggingWillStartCallback = (completion: () -> Unit) -> Unit

Posted when event logging is about to start. You must call completion if this callback is used. You can use this to set up attributes that should be set before any events are sent. The event logger promise has been fulfilled when this callback is called.

Link copied to clipboard

Used for providing a potential header view for the featured view.

Link copied to clipboard

Interface for listening to when the navigation level in the library UI changes.

Link copied to clipboard
class MiniplayerController(binding: <Error class: unknown class>)
Link copied to clipboard

Class for accessing Books resource ids indirectly, for cases where Books is a compileOnly dependency. Add more as needed.

Link copied to clipboard
enum Tab : Enum<Tab> , ITab

Description of a tab in the SDK.

Link copied to clipboard

The type of the tab bar in the main view of the library.

Properties

Link copied to clipboard

The categories composition name.

Link copied to clipboard

The music composition name.

Functions

Link copied to clipboard

Open fragment in the currently visible Book Library UI tab. If a BookLibraryController instance has not been created, this function will suspend until one exists. The returned job can be cancelled if needed.