core/co.cafeyn.cgs.api.content/Medias/all

all

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

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

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.MediaShort.

Parameters

pageSize

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

scope

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

@CheckResult
abstract fun all(mediaIds: List<MediaId>, topicIds: List<TopicId>, publicationIds: List<PublicationId>, pageSize: Int = 20, scope: CoroutineScope): PaginatedResource<MediaShort>

Retrieves a paginated list of media content accessible to the current user profile filtered by mediaIds, topicIds and publicationIds.

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.MediaShort. Returns a PaginatedResource in an error state with co.cafeyn.cgs.api.errors.CgsError.Content.NotFound if all lists are empty.

Parameters

mediaIds

Media identifiers to query.

topicIds

Topic identifiers to query.

publicationIds

Publication identifiers to query.

pageSize

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

scope

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