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

all

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

Retrieves a paginated list of video 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.VideoShort.

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(publicationIds: List<PublicationId>, pageSize: Int = 20, scope: CoroutineScope): PaginatedResource<VideoShort>

Retrieves a paginated list of video content accessible to the current user profile filtered by 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.VideoShort. Returns a PaginatedResource in an error state with co.cafeyn.cgs.api.errors.CgsError.Content.NotFound if publicationIds is empty.

Parameters

publicationIds

One or more 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.