Package-level declarations

Types

Link copied to clipboard
data class AnalyticsEvent(val name: AnalyticsEventId, val parameters: Map<String, String>, val activity: Activity?)

Data class that stores the information of an analytics event

Link copied to clipboard

List of events supported by id used as event name, see AnalyticsEvent.

Link copied to clipboard

Interface to implement if the host app is interested in the analytic events provided by the SDK. An instance of a class implementing this interface can be passed to the Editions constructor.

Link copied to clipboard

List of errors that can happen when trying to present an edition.

Link copied to clipboard
data class DownloadedEdition(val id: UUID, val downloadedDate: Date)

Contains an id that matches Edition.id and the date the edition was downloaded. Use EditionProvider.edition to get an Edition instance.

Link copied to clipboard

Interface to manage downloaded editions.

Link copied to clipboard

Interface for querying the editions on disk, which usually means they are prepared to be presented to the user.

Link copied to clipboard

Errors that can occur when fetching required metadata for downloading an Edition.

Link copied to clipboard

Interface that provides information about the edition download progress.

Link copied to clipboard
data class Edition(val id: UUID, val coverSize: IntSize, val title: String, val description: String?, val date: Date, val isFree: Boolean, val productTag: String, val productName: String, coverUrl: String, metadataVersion: Int, packageVersion: Int)

Data class that holds the display information for an edition, typically used decorate the UI.

Link copied to clipboard

Interface to get the cover for an edition as a Bitmap.

Link copied to clipboard

Interface for downloading and presenting editions to the user.

Link copied to clipboard

Interface for getting the products the issues belong to since the latest feed update, see Editions.updateFeed.

Link copied to clipboard
interface EditionProvider

Interface to get the the editions available since the latest feed update, see Editions.updateFeed.

Link copied to clipboard
class Editions

Main class of Richie Editions SDK.

Link copied to clipboard
data class EditionsConfiguration(val maxZoomFactor: Float = 1.0f)

Configuration class for Editions to be used in its constructor

Link copied to clipboard

Interface to get disk usage from downloaded editions.

Link copied to clipboard

Singleton holder for an Editions instance. instance is null until either create is called or an Editions instance is created elsewhere.

Link copied to clipboard
data class EditionsProduct(val tag: String, val displayName: String)
Link copied to clipboard

This is the exception used when Result.isFailure is true.

Link copied to clipboard

List of errors that can happen when trying to present an edition.

Link copied to clipboard
data class Page(val hasNext: Boolean, val editions: List<Edition>)

This is the class containing the actual Edition objects. You can check hasNext to know if there are more pages in the Paginator.

Link copied to clipboard
interface Paginator

Interface to iterate over the results queried from EditionProvider. Call next as needed until the Paginator is exhausted (Page.hasNext == false). It provides a Result containing a Page on success. NOTE: Calling Editions.updateFeed will render any Paginator object invalid. To keep getting Editions you need to query them again using EditionProvider.editions after an update.