HomeBriefsManager

@HomeExperimentalApi
interface HomeBriefsManager


A manager for home briefs.

Summary

Public functions

suspend HomeBrief?

Fetches a single home brief by its ID, for example the ID received in a Home Brief notification.

suspend HomeBriefsPage
getHomeBriefs(pageSize: Int)

Fetches a paginated list of home briefs.

Public functions

getHomeBrief

suspend fun getHomeBrief(id: Id): HomeBrief?

Fetches a single home brief by its ID, for example the ID received in a Home Brief notification.

Parameters
id: Id

The ID of the home brief to fetch.

Returns
HomeBrief?

The HomeBrief with the given id, or null if no home brief was returned.

Throws
HomeException

if id is blank, if home briefs are not available for this structure, or if the request fails (for example, when no home brief exists with the given id).

getHomeBriefs

suspend fun getHomeBriefs(pageSize: Int = 20): HomeBriefsPage

Fetches a paginated list of home briefs. Default value for pageSize is 20 matching the existing behaviour of the History APIs.

Parameters
pageSize: Int = 20

The maximum number of briefs to return in a single page.

Returns
HomeBriefsPage

A HomeBriefsPage containing the fetched briefs and pagination controls.