BookmarkService Protocol Reference


                    
                    
                    getBookmark(itemId:completion:)

Retrieves the bookmark instance for a given content ID and provides bookmark record when the request is success.Returns error when the request is failed.

Declaration

Swift

func getBookmark(itemId: String, completion: @escaping (Result<BookmarkRecord, Error>) -> Void)

Parameters

`itemId`	The unique identifier fo content.
`completion`	The handle to invoke on request completion


                    
                    
                    getBookmarks(pageNumber:pageSize:sortBy:sortOrder:completion:)

Retrieves all bookmarks from bookmark server. Upon completion provides the list of BookmarkRecords or error.

Declaration

Swift

func getBookmarks(pageNumber: Int?, pageSize: Int?, sortBy: SortBy?, sortOrder: SortOrder?, completion: @escaping (Result<[BookmarkRecord], Error>) -> Void)


                    
                    
                    getSeriesBookmarks(seriesIdentifier:pageNumber:pageSize:sortBy:sortOrder:completion:)

Retrieves requested series-level bookmarks from bookmark server. Upon completion provides the list of BookmarkRecords or error.

Declaration

Swift

func getSeriesBookmarks(seriesIdentifier: String, pageNumber: Int?, pageSize: Int?, sortBy: SortBy?, sortOrder: SortOrder?, completion: @escaping (Result<[BookmarkRecord], Error>) -> Void)


                    
                    
                    getPlaylistBookmarks(playlistIdentifier:pageNumber:pageSize:sortBy:sortOrder:completion:)

Retrieves all video bookmarks for a given playlist. Upon completion provides the list of BookmarkRecords or error.

Declaration

Swift

func getPlaylistBookmarks(playlistIdentifier: String, pageNumber: Int?, pageSize: Int?, sortBy: SortBy?, sortOrder: SortOrder?, completion: @escaping (Result<[BookmarkRecord], Error>) -> Void)


                    
                    
                    getBookmarkCount(completion:)

Retrieves the count of all bookmarks from Bookmarks server and provides the BookmarkCount when the request is success.Returns error when the request is failed.

Declaration

Swift

func getBookmarkCount(completion: @escaping (Result<Int, Error>) -> Void)

Parameters


                                completion

The handle to invoke on request completion


                    
                    
                    putBookmark(itemId:offset:seasonId:episodeId:videoId:mode:seasonNumber:episodeNumber:contentType:completion:)

Default implementation

Inserts bookmark instance for a given content ID and provides the error when the request is failed.

Default Implementation

Declaration

Swift

func putBookmark(
    itemId: String,
    offset: TimeInterval,
    seasonId: String?,
    episodeId: String?,
    videoId: String?,
    mode: Mode?,
    seasonNumber: Int?,
    episodeNumber: Int?,
    contentType: String?,
    completion: @escaping (Result<Void, Error>) -> Void
)


                    
                    
                    deleteBookmark(itemId:episodeId:videoId:mode:completion:)

Default implementation

Deletes bookmark for a given content ID provides the error when the request is failed.

Default Implementation

Declaration

Swift

func deleteBookmark(
    itemId: String,
    episodeId: String?,
    videoId: String?,
    mode: Mode?,
    completion: @escaping (Result<Void, Error>) -> Void
)