Exosphere.Bsky.Actor (Exosphere v0.4.0)

Copy Markdown View Source

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

Generated from vendored lexicons — DO NOT EDIT.

Endpoints

  • get_preferences — query: app.bsky.actor.getPreferences
  • get_profile — query: app.bsky.actor.getProfile
  • get_profiles — query: app.bsky.actor.getProfiles
  • get_suggestions — query: app.bsky.actor.getSuggestions
  • put_preferences — procedure: app.bsky.actor.putPreferences
  • search_actors — query: app.bsky.actor.searchActors
  • search_actors_typeahead — query: app.bsky.actor.searchActorsTypeahead

Summary

Functions

Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.

Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.

Get detailed profile views of multiple actors.

Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.

Set the private preferences attached to the account.

Find actors (profiles) matching search criteria. Does not require auth.

Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.

Functions

get_preferences(client)

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

Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.

## Parameters

get_profile(client, params \\ [])

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

Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.

## Parameters

  • actor (string, required): Handle or DID of account to fetch profile of.

get_profiles(client, params \\ [])

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

Get detailed profile views of multiple actors.

## Parameters

  • actors (array, required)

get_suggestions(client, params \\ [])

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

Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.

## Parameters

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

put_preferences(client, body \\ %{})

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

Set the private preferences attached to the account.

search_actors(client, params \\ [])

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

Find actors (profiles) matching search criteria. Does not require auth.

## Parameters

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

search_actors_typeahead(client, params \\ [])

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

Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.

## Parameters

  • limit (integer, optional)
  • q (string, optional): Search query prefix; not a full query string.
  • term (string, optional): DEPRECATED: use 'q' instead.