Exosphere.Bsky.Bookmark (Exosphere v0.4.0)

Copy Markdown View Source

XRPC client functions for the app.bsky.bookmark namespace.

Generated from vendored lexicons — DO NOT EDIT.

Endpoints

  • create_bookmark — procedure: app.bsky.bookmark.createBookmark
  • delete_bookmark — procedure: app.bsky.bookmark.deleteBookmark
  • get_bookmarks — query: app.bsky.bookmark.getBookmarks

Summary

Functions

Creates a private bookmark for the specified record. Currently, only app.bsky.feed.post records are supported. Requires authentication.

Deletes a private bookmark for the specified record. Currently, only app.bsky.feed.post records are supported. Requires authentication.

Gets views of records bookmarked by the authenticated user. Requires authentication.

Functions

create_bookmark(client, body \\ %{})

@spec create_bookmark(Exosphere.ATProto.XRPC.Client.t(), map()) ::
  {:ok, map()} | {:error, term()}

Creates a private bookmark for the specified record. Currently, only app.bsky.feed.post records are supported. Requires authentication.

delete_bookmark(client, body \\ %{})

@spec delete_bookmark(Exosphere.ATProto.XRPC.Client.t(), map()) ::
  {:ok, map()} | {:error, term()}

Deletes a private bookmark for the specified record. Currently, only app.bsky.feed.post records are supported. Requires authentication.

get_bookmarks(client, params \\ [])

@spec get_bookmarks(Exosphere.ATProto.XRPC.Client.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

Gets views of records bookmarked by the authenticated user. Requires authentication.

## Parameters

  • cursor (string, optional)
  • limit (integer, optional)