BookmarksService

Provides Bookmark Microservice client access protocol (API)

Types

abstract suspend fun deleteBookmark(contentId: String, episodeId: String? = null, mode: Mode? = null): Result<Unit, Error>

Deletes a bookmark instance for a given content identifier if successful.

Fetches a BookmarksRecord instance for a given content identifier if successful.

abstract suspend fun getBookmarks(pageNumber: Int = DEFAULT_PAGE_NUM, pageSize: Int = DEFAULT_PAGE_SIZE, sortBy: SortByType = SortByType.TIMESTAMP, sortOrder: SortOrderType = SortOrderType.DESC): Result<List<BookmarksRecord>, Error>

Fetches, from the Bookmark Microservice, a collection of BookmarksRecord instances if successful.

Fetches a count of all bookmark instances if successful.

abstract suspend fun getSeriesBookmarks(seriesIdentifier: String, pageNumber: Int = DEFAULT_PAGE_NUM, pageSize: Int = DEFAULT_PAGE_SIZE, sortBy: SortByType = SortByType.TIMESTAMP, sortOrder: SortOrderType = SortOrderType.DESC): Result<List<BookmarksRecord>, Error>

Fetches a collection of BookmarksRecord instances for a given series identifier if successful.

abstract suspend fun putBookmark(contentId: String, offset: Long, seasonId: String? = null, episodeId: String? = null, seasonNumber: Int? = null, episodeNumber: Int? = null, musicId: String? = null, mode: Mode? = null): Result<Unit, Error>

Inserts a bookmark instance for a given content identifier if successful.