core/co.cafeyn.cgs.api

Package-level declarations

The SDK's front door. CGS is the singleton every other service is reached through, SdkConfig configures it, and the service interfaces it hands out — Content, Download, Readings, ReadingList — live here too.

Types

Link copied to clipboard
object CGS

The SDK's entry point: initialize it here, then reach every service from here.

Link copied to clipboard
enum CgsEnvironment : Enum<CgsEnvironment>

Which backend the SDK talks to.

Link copied to clipboard
interface Content

Everything the catalogue holds — articles, issues, videos, media and publications — as seen by the profile currently active on the session.

Link copied to clipboard
interface Download

Fetching issues onto the device so they can be read offline, and following what the fetching is doing.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY])
annotation class InternalCGSApi

Marks a declaration as internal to the SDK.

Link copied to clipboard
interface ReadingList

Issues the user has set aside to read later.

Link copied to clipboard
interface Readings

How far into each issue the reader got.

Link copied to clipboard
data class ReadingStatus(val progress: Float, val lastPageRead: Int)

How far into one issue the reader got.

Link copied to clipboard
class SdkConfig

How the SDK is set up. Build one and hand it to CGS.init.