booklibraryui/fi.richie.booklibraryui

Package-level declarations

Types

ActionBarProvider

interface ActionBarProvider

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

AppconfigAlertPresenter

object AppconfigAlertPresenter

Class for presenting alerts present in the config.

AppconfigDataCallback

typealias AppconfigDataCallback = (String) -> Unit

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

AudioPlayerGateway

class AudioPlayerGateway : PlayerEventListener

Provides the current state of the audiobook and live audio players (if either exist), and also updates.

BookLibraryController

class BookLibraryController(context: Context, applicationIdentifier: String, extraCompositions: Collection<String> = emptyList(), adManager: AdManager, tokenProvider: TokenProvider, editionsBooksContext: EditionsBooksContext? = null, bookOpening: BookOpening? = null, categoryListIconProvider: CategoryListIconProvider? = null, fontProvider: DataBindingValueProvider.Fonts? = null, colorProvider: DataBindingValueProvider.Colors? = null, enableSyncByDefault: Boolean, appdataNetworking: AppdataNetworking? = null, analyticsEventListener: BooksAnalyticsEventListener? = null)

The main entry point for the Book Library UI SDK.

BookLibraryUiConfiguration

data class BookLibraryUiConfiguration(val topLevelTitle: String? = null, val libraryFilters: List<Filter>? = null, val showBlurredDetailBackground: Boolean? = null, val defaultCoverSize: IntSize? = null, val detailView: BookLibraryUiConfiguration.DetailView? = null, val podcastSeriesView: BookLibraryUiConfiguration.PodcastSeriesView? = null, val coverCornerRadiusRatio: Int? = null)

Configuration class for various UI bits.

BookOpening

interface BookOpening

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

BookOpeningPolicy

enum BookOpeningPolicy : Enum<BookOpeningPolicy>

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

BooksView

sealed interface BooksView

BooksViewModel

class BooksViewModel : ViewModel

BookType

sealed interface BookType

Description of a library entry's media type.

CategoryListIconProvider

interface CategoryListIconProvider

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

ConfigHolder

object ConfigHolder

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

ContentState

class ContentState

Class for following the state of the content feed.

ContentUpdateListener

typealias ContentUpdateListener = (ContentState.State) -> Unit

The listener for the content feed state.

EventLoggingWillStartCallback

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.

ExternalEvents

interface ExternalEvents

Events that should be consumed by SDK users.

FeaturedHeaderViewUpdater

interface FeaturedHeaderViewUpdater

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

MiniplayerController

class MiniplayerController(binding: BooklibraryuiMiniplayerBinding)

PodcastPlaybackErrorCode

enum PodcastPlaybackErrorCode : Enum<PodcastPlaybackErrorCode>

Error codes returned from BookLibraryController.playPodcastEpisode when playback cannot be started. Numeric codes are stable and intended to be shown to end users (e.g. in a toast) so that the failure cause can be reported without exposing untranslated English strings.

PodcastPlaybackException

class PodcastPlaybackException(val errorCode: PodcastPlaybackErrorCode) : Exception

ResourceIds

object ResourceIds

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

SearchMediaKind

enum SearchMediaKind : Enum<SearchMediaKind>

The kind of content a search covers.

Tab

enum Tab : ITab, Enum<Tab>

Description of a tab in the SDK.

TabBarType

enum TabBarType : Enum<TabBarType>

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

UiHelpers

class UiHelpers @JvmOverloads constructor(val activity: () -> Activity?, val externalFragmentOpener: (Fragment) -> Unit? = null, val isRootViewInHostHierarchy: Boolean = false, val externalFragmentCloser: () -> Unit? = null, val contentInsets: (Fragment) -> StateFlow<Insets>?? = null)

Helpers to allow Books to open activities and fragments.

Properties

CATEGORIES_COMPOSITION_NAME

const val CATEGORIES_COMPOSITION_NAME: String

The categories composition name.

MUSIC_COMPOSITION_NAME

const val MUSIC_COMPOSITION_NAME: String

The music composition name.

Functions

installBookLibraryView

fun installBookLibraryView(layoutInflater: LayoutInflater, containerView: ViewGroup): BooklibraryuiMainLayoutBinding

Inflates the Book Library's view structure synchronously into containerView and returns the resulting binding, which must then be passed to BookLibraryController.showLibraryInView.

openFragmentInCurrentBookLibraryTab

fun openFragmentInCurrentBookLibraryTab(sourceFragment: Fragment, fragment: Fragment): Job

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.