getSeriesBookmarks

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.

Return

Result.Success with a com.quickplay.vstb7.platform.model.MultiDataResponse containing a collection of BookmarksRecord object if the Bookmark Microservice call is successful or Result.Failure with Error object otherwise.

Parameters

seriesIdentifier

unique identifier of the series.

pageNumber

number value that indicates the page to retrieve (optional).

pageSize

number value that indicates the number of records to return in response (optional).

sortBy

specifies that the records are to be sorted by SortByType.TIMESTAMP (default).

sortOrder

specifies that the records are to be ordered by either SortOrderType.DESC (default) or SortOrderType.ASC