Exosphere.Bsky.Graph (Exosphere v0.6.0)

Copy Markdown View Source

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

Generated from vendored lexicons — DO NOT EDIT.

Endpoints

  • get_actor_starter_packs — query: app.bsky.graph.getActorStarterPacks
  • get_blocks — query: app.bsky.graph.getBlocks
  • get_followers — query: app.bsky.graph.getFollowers
  • get_follows — query: app.bsky.graph.getFollows
  • get_known_followers — query: app.bsky.graph.getKnownFollowers
  • get_list — query: app.bsky.graph.getList
  • get_list_blocks — query: app.bsky.graph.getListBlocks
  • get_list_mutes — query: app.bsky.graph.getListMutes
  • get_lists — query: app.bsky.graph.getLists
  • get_lists_with_membership — query: app.bsky.graph.getListsWithMembership
  • get_mutes — query: app.bsky.graph.getMutes
  • get_relationships — query: app.bsky.graph.getRelationships
  • get_starter_pack — query: app.bsky.graph.getStarterPack
  • get_starter_packs — query: app.bsky.graph.getStarterPacks
  • get_starter_packs_with_membership — query: app.bsky.graph.getStarterPacksWithMembership
  • get_suggested_follows_by_actor — query: app.bsky.graph.getSuggestedFollowsByActor
  • mute_actor — procedure: app.bsky.graph.muteActor
  • mute_actor_list — procedure: app.bsky.graph.muteActorList
  • mute_thread — procedure: app.bsky.graph.muteThread
  • search_starter_packs — query: app.bsky.graph.searchStarterPacks
  • search_starter_packs_v2 — query: app.bsky.graph.searchStarterPacksV2
  • unmute_actor — procedure: app.bsky.graph.unmuteActor
  • unmute_actor_list — procedure: app.bsky.graph.unmuteActorList
  • unmute_thread — procedure: app.bsky.graph.unmuteThread

Summary

Functions

Get a list of starter packs created by the actor.

Enumerates which accounts the requesting account is currently blocking. Requires auth.

Enumerates accounts which follow a specified account (actor).

Enumerates accounts which a specified account (actor) follows.

Enumerates accounts which follow a specified account (actor) and are followed by the viewer.

Gets a 'view' (with additional context) of a specified list.

Get mod lists that the requesting account (actor) is blocking. Requires auth.

Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.

Enumerates the lists created by a specified account (actor).

Enumerates the lists created by the session user, and includes membership information about actor in those lists. Only supports curation and moderation lists (no reference lists, used in starter packs). Requires auth.

Enumerates accounts that the requesting account (actor) currently has fully muted. Mutes scoped to specific kinds of content (only reposts, only quote posts) are not included. Responses may contain more items than the requested limit. Requires auth.

Enumerates public relationships between one account, and a list of other accounts. Does not require auth.

Gets a view of a starter pack.

Get views for a list of starter packs.

Enumerates the starter packs created by the session user, and includes membership information about actor in those starter packs. Requires auth.

Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.

Creates a mute relationship for the specified account. If a mute already exists for the account, it is updated in place: the stored scope is replaced with the scope in this request. Mutes are private in Bluesky. Requires auth.

Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth.

Mutes a thread preventing notifications from the thread and any of its children. Mutes are private in Bluesky. Requires auth.

Find starter packs matching search criteria. Does not require auth.

Find starter packs matching search criteria. Does not require auth.

Unmutes the specified account. Requires auth.

Unmutes the specified list of accounts. Requires auth.

Unmutes the specified thread. Requires auth.

Functions

get_actor_starter_packs(client, params \\ [])

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

Get a list of starter packs created by the actor.

## Parameters

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

get_blocks(client, params \\ [])

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

Enumerates which accounts the requesting account is currently blocking. Requires auth.

## Parameters

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

get_followers(client, params \\ [])

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

Enumerates accounts which follow a specified account (actor).

## Parameters

  • actor (string, required)
  • cursor (string, optional)
  • limit (integer, optional)
  • sort (string, optional)

get_follows(client, params \\ [])

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

Enumerates accounts which a specified account (actor) follows.

## Parameters

  • actor (string, required)
  • cursor (string, optional)
  • limit (integer, optional)
  • sort (string, optional)

get_known_followers(client, params \\ [])

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

Enumerates accounts which follow a specified account (actor) and are followed by the viewer.

## Parameters

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

get_list(client, params \\ [])

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

Gets a 'view' (with additional context) of a specified list.

## Parameters

  • cursor (string, optional)
  • limit (integer, optional)
  • list (string, required): Reference (AT-URI) of the list record to hydrate.

get_list_blocks(client, params \\ [])

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

Get mod lists that the requesting account (actor) is blocking. Requires auth.

## Parameters

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

get_list_mutes(client, params \\ [])

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

Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.

## Parameters

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

get_lists(client, params \\ [])

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

Enumerates the lists created by a specified account (actor).

## Parameters

  • actor (string, required): The account (actor) to enumerate lists from.
  • cursor (string, optional)
  • limit (integer, optional)
  • purposes (array, optional): Optional filter by list purpose. If not specified, all supported types are returned.

get_lists_with_membership(client, params \\ [])

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

Enumerates the lists created by the session user, and includes membership information about actor in those lists. Only supports curation and moderation lists (no reference lists, used in starter packs). Requires auth.

## Parameters

  • actor (string, required): The account (actor) to check for membership.
  • cursor (string, optional)
  • limit (integer, optional)
  • purposes (array, optional): Optional filter by list purpose. If not specified, all supported types are returned.

get_mutes(client, params \\ [])

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

Enumerates accounts that the requesting account (actor) currently has fully muted. Mutes scoped to specific kinds of content (only reposts, only quote posts) are not included. Responses may contain more items than the requested limit. Requires auth.

## Parameters

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

get_relationships(client, params \\ [])

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

Enumerates public relationships between one account, and a list of other accounts. Does not require auth.

## Parameters

  • actor (string, required): Primary account requesting relationships for.
  • others (array, optional): List of 'other' accounts to be related back to the primary.

get_starter_pack(client, params \\ [])

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

Gets a view of a starter pack.

## Parameters

  • starterPack (string, required): Reference (AT-URI) of the starter pack record.

get_starter_packs(client, params \\ [])

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

Get views for a list of starter packs.

## Parameters

  • uris (array, required)

get_starter_packs_with_membership(client, params \\ [])

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

Enumerates the starter packs created by the session user, and includes membership information about actor in those starter packs. Requires auth.

## Parameters

  • actor (string, required): The account (actor) to check for membership.
  • cursor (string, optional)
  • limit (integer, optional)

get_suggested_follows_by_actor(client, params \\ [])

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

Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.

## Parameters

  • actor (string, required)

mute_actor(client, body \\ %{})

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

Creates a mute relationship for the specified account. If a mute already exists for the account, it is updated in place: the stored scope is replaced with the scope in this request. Mutes are private in Bluesky. Requires auth.

mute_actor_list(client, body \\ %{})

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

Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth.

mute_thread(client, body \\ %{})

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

Mutes a thread preventing notifications from the thread and any of its children. Mutes are private in Bluesky. Requires auth.

search_starter_packs(client, params \\ [])

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

Find starter packs matching search criteria. Does not require auth.

## Parameters

  • cursor (string, optional)
  • limit (integer, optional)
  • q (string, required): Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.

search_starter_packs_v2(client, params \\ [])

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

Find starter packs matching search criteria. Does not require auth.

## Parameters

  • cursor (string, optional)
  • limit (integer, optional)
  • q (string, required): Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.

unmute_actor(client, body \\ %{})

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

Unmutes the specified account. Requires auth.

unmute_actor_list(client, body \\ %{})

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

Unmutes the specified list of accounts. Requires auth.

unmute_thread(client, body \\ %{})

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

Unmutes the specified thread. Requires auth.