Exosphere.Bsky.Contact (Exosphere v0.3.0)

Copy Markdown View Source

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

Generated from vendored lexicons — DO NOT EDIT.

Endpoints

  • dismiss_match — procedure: app.bsky.contact.dismissMatch
  • get_matches — query: app.bsky.contact.getMatches
  • get_sync_status — query: app.bsky.contact.getSyncStatus
  • import_contacts — procedure: app.bsky.contact.importContacts
  • remove_data — procedure: app.bsky.contact.removeData
  • send_notification — procedure: app.bsky.contact.sendNotification
  • start_phone_verification — procedure: app.bsky.contact.startPhoneVerification
  • verify_phone — procedure: app.bsky.contact.verifyPhone

Summary

Functions

Removes a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication.

Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.

Gets the user's current contact import status. Requires authentication.

Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.

Removes all stored hashes used for contact matching, existing matches, and sync status. Requires authentication.

System endpoint to send notifications related to contact imports. Requires role authentication.

Starts a phone verification flow. The phone passed will receive a code via SMS that should be passed to app.bsky.contact.verifyPhone. Requires authentication.

Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.

Functions

dismiss_match(client, body \\ %{})

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

Removes a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication.

get_matches(client, params \\ [])

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

Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.

## Parameters

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

get_sync_status(client)

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

Gets the user's current contact import status. Requires authentication.

## Parameters

import_contacts(client, body \\ %{})

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

Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.

remove_data(client, body \\ %{})

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

Removes all stored hashes used for contact matching, existing matches, and sync status. Requires authentication.

send_notification(client, body \\ %{})

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

System endpoint to send notifications related to contact imports. Requires role authentication.

start_phone_verification(client, body \\ %{})

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

Starts a phone verification flow. The phone passed will receive a code via SMS that should be passed to app.bsky.contact.verifyPhone. Requires authentication.

verify_phone(client, body \\ %{})

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

Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.