editions/fi.richie.editions

Package-level declarations

Types

AnalyticsEvent

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

Data class that stores the information of an analytics event

AnalyticsEventId

enum AnalyticsEventId : Enum<AnalyticsEventId>

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

AnalyticsListener

interface AnalyticsListener

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.

CoverError

enum CoverError : Enum<CoverError>

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

DownloadedEdition

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.

DownloadedEditionsManager

interface DownloadedEditionsManager

Interface to manage downloaded editions.

DownloadedEditionsProvider

interface DownloadedEditionsProvider

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

DownloadInfoException

sealed class DownloadInfoException : Exception

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

DownloadProgressListener

interface DownloadProgressListener

Interface that provides information about the edition download progress.

Edition

data class Edition(val id: UUID, val coverSize: IntSize, val title: String, val description: String?, val date: Date, val featuredUntil: 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.

EditionCounts

typealias EditionCounts = Map<String, Map<String, Int>>

Type alias to reduce code verbosity. The result of EditionProvider.editionCounts.

EditionCoverBitmapProvider

interface EditionCoverBitmapProvider

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

EditionCoverBytesProvider

interface EditionCoverBytesProvider

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

EditionCoverProvider

interface EditionCoverProvider : EditionCoverBitmapProvider, EditionCoverBytesProvider

A combination of the edition cover provider interfaces.

EditionPresenter

interface EditionPresenter

Interface for downloading and presenting editions to the user.

EditionProductsProvider

interface EditionProductsProvider

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

EditionProvider

interface EditionProvider

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

Editions

class Editions(appId: String, tokenProvider: TokenProvider, analyticsListener: AnalyticsListener?, context: Context, adManager: AdManager?, configuration: EditionsConfiguration = EditionsConfiguration(), appdataNetworking: AppdataNetworking? = null)

Main class of Richie Editions SDK.

EditionsConfiguration

data class EditionsConfiguration(val storageLocation: StorageOption = StorageOption.INTERNAL)

Configuration class for Editions to be used in its constructor

EditionsDiskUsageProvider

interface EditionsDiskUsageProvider

Interface to get disk usage from downloaded editions.

EditionsHolder

object EditionsHolder

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

EditionsProduct

data class EditionsProduct(val tag: String, val displayName: String)

InvalidPaginatorException

class InvalidPaginatorException : Exception

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

OpenError

enum OpenError : Enum<OpenError>

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

Page

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.

Paginator

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.

Functions

editionAsync

suspend fun EditionProvider.editionAsync(id: UUID): Edition?

Coroutine version of EditionProvider.edition.

editionCountsAsync

suspend fun EditionProvider.editionCountsAsync(productTags: List<String>? = null): EditionCounts

Coroutine version of EditionProvider.editionCounts.

nextAsync

suspend fun Paginator.nextAsync(): Page

Coroutine version of Paginator.next.