core/co.cafeyn.cgs.api.content/Issues

Issues

interface Issues

The issue catalogue: one dated release of a publication, downloadable and readable page by page.

Reached through Content.issues. get resolves one issue in full — page count, cover, format — while the all overloads list them in their light IssueShort form. To read one, pass its id to Reader.open, which downloads it on the spot if it is not on the device; Download is for fetching it ahead of time.

val archives = CGS.content().issues.all(
    issueIds = emptyList(),
    publicationIds = listOf(publicationId),
    dates = DateRange.ofYear(2025),
    scope = viewModelScope
)

Everything here follows the active profile and is bound to the scope you pass — see Content.

Functions

addIns

@CheckResult

abstract fun addIns(id: IssueId, pageSize: Int = 20, scope: CoroutineScope): PaginatedResource<IssueShort>

Retrieves a paginated list of the add-ins shipped with id — the supplements that came with that release, each one an issue of another publication which a reader entitled to id can also read.

all

@CheckResult

abstract fun all(pageSize: Int = 20, scope: CoroutineScope): PaginatedResource<IssueShort>

Retrieves a paginated list of issue content accessible to the current user profile.

@CheckResult

abstract fun all(issueIds: List<IssueId>, publicationIds: List<PublicationId>, dates: DateRange? = null, pageSize: Int = 20, scope: CoroutineScope): PaginatedResource<IssueShort>

Retrieves a paginated list of issue content accessible to the current user profile filtered by issueIds and publicationIds, optionally narrowed to the issues released within dates.

get

abstract suspend fun get(id: IssueId, scope: CoroutineScope): StateFlow<CgsStreamState<Issue?>>

Observes an issue by its identifier, reacting to changes in the active session.