Interface BookmarksModule

interface BookmarksModule {
    createBookmark(command: CreateBookmarkCommand): Promise<string>;
    deleteBookmark(bookmarkUri: string): Promise<void>;
    discoverStorage(webId: string): Promise<BookmarkStorage>;
    listBookmarks(storageUrl: string): Promise<Bookmark[]>;
    updateBookmark(command: UpdateBookmarkCommand): Promise<void>;
}

Implemented by

default

Index

Methods

createBookmark deleteBookmark discoverStorage listBookmarks updateBookmark

Methods

createBookmark

createBookmark(command): Promise<string>
Create a new bookmark at the given storage. Potential storage URLs can be discovered using discoverStorage.
Parameters
- command: CreateBookmarkCommand
Returns Promise<string>
- Defined in index.ts:91

deleteBookmark

deleteBookmark(bookmarkUri): Promise<void>
Deletes the given bookmark
Parameters
- bookmarkUri: string
  The URI of the bookmark resource to delete
Returns Promise<void>
- Defined in index.ts:103

discoverStorage

discoverStorage(webId): Promise<BookmarkStorage>
Discover configured storages for Bookmarks (containers and/or documents) from private and public type indexes of the given WebID
Parameters
- webId: string
  The WebID whose indexes to search
Returns Promise<BookmarkStorage>
- Defined in index.ts:79

listBookmarks

listBookmarks(storageUrl): Promise<Bookmark[]>
List all bookmarks stored at the given location
Parameters
- storageUrl: string
  The URL of the container or document to look into for bookmarks
Returns Promise<Bookmark[]>
- Defined in index.ts:85

updateBookmark

updateBookmark(command): Promise<void>
Updates a given bookmark to new values
Parameters
- command: UpdateBookmarkCommand
Returns Promise<void>
- Defined in index.ts:97