Home > @activeviam/activeui-sdk > BookmarksApi
BookmarksApi interface
Signature:
export interface BookmarksApi
Properties
| Property | Type | Description |
|---|---|---|
| _getBookmarksManager | () => BookmarksManager | |
| create | (bookmark: Bookmark, parentPath: string, owners: PermissionGroups, readers: PermissionGroups) => Promise<BookmarkMetaData> | Create a bookmark. If owners/readers are unspecified, they default to an array containing the current username as single element. |
| delete | (id: BookmarkId, path: BookmarkPath) => Promise<void> | Delete the bookmark identified by its BookmarkId and path. |
| findBookmark | (predicate: (a: BookmarkDescription) => boolean) => Promise<BookmarkDescription> | Returns the first bookmark that matches a predicate, where the predicate takes as parameter a bookmark and returns a boolean. |
| findBookmarkIdByName | (name: BookmarkName) => Promise<BookmarkId> | This function will iterate through the bookmarks and return the first bookmark id matching name. |
| getAllBookmarks | () => Promise<BookmarkDescription[]> | |
| getBookmark | (id: BookmarkId) => Promise<BookmarkDescription> | Retrieve a bookmark identified by its BookmarkId. |