addIns

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.

Keyed by issue rather than by publication: add-ins belong to a dated release, so two issues of the same title can carry different ones, or none at all. An issue with no add-ins resolves to an empty resource, not an error.

Each item carries the publication it belongs to on IssueShort.publication, which is what names an add-in on screen — unlike all, where every item is a release of the publication asked for.

The returned PaginatedResource's reactivity (restarting on account or profile change, and on auth state changes) is bound to scope: its internal machinery stops five seconds after PaginatedResource.state loses its last collector, and resumes on the next collection.

Return

A PaginatedResource wrapping the fetched co.cafeyn.cgs.api.model.IssueShort.

Parameters

id

The issue whose add-ins to list.

pageSize

Specify a limit for the number of items returned per page.

scope

The CoroutineScope used to bound the lifecycle of the returned PaginatedResource.