Class Bookmark

The Bookmark class provides methods for CRUD over Bookmark resources in Solid.

Constructors

constructor

Methods

create delete get getAll update

Constructors

constructor

Methods

Static create

  • create(payload, fetch, webId, defaultPrivateBookmarkDocUrl?): Promise<boolean>

  • Creates a new bookmark.

    Parameters

    • payload: ICreateBookmark

      The bookmark data.

    • fetch: {
          (input, init?): Promise<Response>;
          (input, init?): Promise<Response>;
      }

      The fetch function.

        • (input, init?): Promise<Response>

        • MDN Reference

          Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

        • (input, init?): Promise<Response>

        • Parameters

          • input: string | Request | URL
          • Optional init: RequestInit

          Returns Promise<Response>

    • webId: string

      The user's WebID.

    • Optional defaultPrivateBookmarkDocUrl: string

      Doc to store the bookmark in if no type registration is foundj

    Returns Promise<boolean>

    A promise resolving to true if the bookmark was created, false otherwise.

Static delete

  • delete(url, fetch): Promise<boolean>

  • Deletes the bookmark at the given URL.

    Parameters

    • url: string

      The URL of the bookmark to delete.

    • fetch: {
          (input, init?): Promise<Response>;
          (input, init?): Promise<Response>;
      }

      The fetch function to use for network requests.

        • (input, init?): Promise<Response>

        • MDN Reference

          Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

        • (input, init?): Promise<Response>

        • Parameters

          • input: string | Request | URL
          • Optional init: RequestInit

          Returns Promise<Response>

    Returns Promise<boolean>

    A promise resolving to true if the bookmark was deleted, false otherwise.

Static get

  • get(url, fetch): Promise<undefined | IBookmark>

  • Gets a bookmark by URL.

    Parameters

    • url: string

      The URL of the bookmark to get.

    • fetch: {
          (input, init?): Promise<Response>;
          (input, init?): Promise<Response>;
      }

      The fetch function to use for network requests.

        • (input, init?): Promise<Response>

        • MDN Reference

          Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

        • (input, init?): Promise<Response>

        • Parameters

          • input: string | Request | URL
          • Optional init: RequestInit

          Returns Promise<Response>

    Returns Promise<undefined | IBookmark>

    A promise resolving to the bookmark, if found, or undefined.

Static getAll

  • getAll(fetch, webId, defaultPrivateBookmarkDocUrl?): Promise<IBookmark[]>

  • Gets all bookmarks for the given user's webId.

    Parameters

    • fetch: {
          (input, init?): Promise<Response>;
          (input, init?): Promise<Response>;
      }

      The fetch function to use for network requests.

        • (input, init?): Promise<Response>

        • MDN Reference

          Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

        • (input, init?): Promise<Response>

        • Parameters

          • input: string | Request | URL
          • Optional init: RequestInit

          Returns Promise<Response>

    • webId: string

      The user's webId.

    • Optional defaultPrivateBookmarkDocUrl: string

      The default container url

    Returns Promise<IBookmark[]>

    A promise resolving to an array of the user's bookmarks.

Static update

  • update(url, payload, fetch): Promise<undefined | IBookmark>

  • Updates a bookmark resource in a Solid pod by replacing its metadata with the provided payload.

    Parameters

    • url: string

      The URL of the bookmark resource to update

    • payload: IUpdateBookmark

      The updated bookmark metadata

    • fetch: {
          (input, init?): Promise<Response>;
          (input, init?): Promise<Response>;
      }

      The fetch function to use for network requests

        • (input, init?): Promise<Response>

        • MDN Reference

          Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

        • (input, init?): Promise<Response>

        • Parameters

          • input: string | Request | URL
          • Optional init: RequestInit

          Returns Promise<Response>

    Returns Promise<undefined | IBookmark>

    The updated bookmark object if successful, else undefined

Settings

Member Visibility

Theme

On This Page

constructorcreatedeletegetgetAllupdate