pspdfkit/com.pspdfkit.bookmarks/BookmarkProvider

BookmarkProvider

interface BookmarkProvider

Handles all bookmark related operations on the owning document. Retrieve it with getBookmarkProvider

Types

Link copied to clipboard
interface BookmarkListener
Listener for notifying other components when bookmarks change.

Functions

Link copied to clipboard
abstract fun addBookmark(@NonNull bookmark: Bookmark): Boolean
Adds a new bookmark to the document.
Link copied to clipboard
@NonNull
abstract fun addBookmarkAsync(@NonNull bookmark: Bookmark): Completable
Adds bookmark to the document.
Link copied to clipboard
abstract fun addBookmarkListener(@NonNull listener: BookmarkProvider.BookmarkListener)
Adds a BookmarkListener for being notified when bookmarks have been changed.
Link copied to clipboard
@NonNull
abstract fun getBookmarks(): List<Bookmark>
Returns the list of bookmarks in the document.
Link copied to clipboard
@NonNull
abstract fun getBookmarksAsync(): Observable<List<Bookmark>>
Returns the list of bookmarks in the document.
Link copied to clipboard
abstract fun hasUnsavedChanges(): Boolean
Returns true if there were any changes to the bookmarks without save.
Link copied to clipboard
abstract fun removeBookmark(@NonNull bookmark: Bookmark): Boolean
Removes bookmark from the document.
Link copied to clipboard
@NonNull
abstract fun removeBookmarkAsync(@NonNull bookmark: Bookmark): Completable
Remove bookmark from the document.
Link copied to clipboard
abstract fun removeBookmarkListener(@NonNull listener: BookmarkProvider.BookmarkListener)
Removes a previously registered BookmarkListener.