Richie

A unified factory for various SDKs provided by Richie.

You can use this factory for getting instances of AdManager, Editions, and BookLibraryController with the factory managing the bulk of configuration.

All functions must be called from the main thread.

Functions

ads

suspend fun ads(): AdManager

fun ads(completion: (AdManager?) -> Unit)

Creates an AdManager instance, or provides the existing instance if one has already been created.

books

suspend fun books(tokenProvider: TokenProvider, analyticsListener: AnalyticsListener? = null, configuration: EditionsConfiguration = EditionsConfiguration(), bookOpening: BookOpening? = null, categoryListIconProvider: CategoryListIconProvider? = null, bindingOverrideAdapterFactory: BindingOverrideAdapterFactory? = null, fontProvider: DataBindingValueProvider.Fonts? = null, colorProvider: DataBindingValueProvider.Colors? = null, analyticsEventListener: BooksAnalyticsEventListener? = null, extraCompositions: Collection<String> = emptyList(), enableSyncByDefault: Boolean = true): BookLibraryController

fun books(tokenProvider: TokenProvider, analyticsListener: AnalyticsListener? = null, configuration: EditionsConfiguration = EditionsConfiguration(), bookOpening: BookOpening? = null, categoryListIconProvider: CategoryListIconProvider? = null, bindingOverrideAdapterFactory: BindingOverrideAdapterFactory? = null, fontProvider: DataBindingValueProvider.Fonts? = null, colorProvider: DataBindingValueProvider.Colors? = null, extraCompositions: Collection<String> = emptyList(), enableSyncByDefault: Boolean = true, completion: (BookLibraryController?) -> Unit)

Creates and initializes a BookLibraryController instance, or provides the existing instance if one has already been created. Note that this method handles calling Editions.initialize too.

editions

suspend fun editions(tokenProvider: TokenProvider, analyticsListener: AnalyticsListener? = null, configuration: EditionsConfiguration = EditionsConfiguration(), bookmarksGateway: BookmarksGateway? = null): Editions

fun editions(tokenProvider: TokenProvider, analyticsListener: AnalyticsListener? = null, configuration: EditionsConfiguration = EditionsConfiguration(), bookmarksGateway: BookmarksGateway? = null, completion: (Editions?) -> Unit)

Creates and initializes an Editions instance, or provides the existing instance if one has already been created. Note that this method handles calling Editions.initialize too.

enableLogging

fun enableLogging()

Shortcut for setting the log level to Log.Level.VERBOSE. The default is Log.Level.WARN.

setConsentKeys

fun setConsentKeys(keys: List<String>)

Updates privacy policy consent keys.

setLogLevel

fun setLogLevel(level: Int)

Set the log level for the Richie SDK's internal logger. level must be one of the values defined in Log.Level. The default is Log.Level.WARN.

start

fun start(richieAppIdentifier: String, context: Context, storageLocation: StorageOption = StorageOption.INTERNAL)

Initializes the SDK factory. Must be called before calling any of the factory methods.