Exosphere.Bsky.Notification (Exosphere v0.4.0)

Copy Markdown View Source

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

Generated from vendored lexicons — DO NOT EDIT.

Endpoints

  • get_preferences — query: app.bsky.notification.getPreferences
  • get_unread_count — query: app.bsky.notification.getUnreadCount
  • list_activity_subscriptions — query: app.bsky.notification.listActivitySubscriptions
  • list_notifications — query: app.bsky.notification.listNotifications
  • put_activity_subscription — procedure: app.bsky.notification.putActivitySubscription
  • put_preferences — procedure: app.bsky.notification.putPreferences
  • put_preferences_v2 — procedure: app.bsky.notification.putPreferencesV2
  • register_push — procedure: app.bsky.notification.registerPush
  • unregister_push — procedure: app.bsky.notification.unregisterPush
  • update_seen — procedure: app.bsky.notification.updateSeen

Summary

Functions

get_preferences(client)

Get notification-related preferences for an account. Requires auth.

get_unread_count(client, params \\ [])

Count the number of unread notifications for the requesting account. Requires auth.

list_activity_subscriptions(client, params \\ [])

Enumerate all accounts to which the requesting account is subscribed to receive notifications for. Requires auth.

list_notifications(client, params \\ [])

Enumerate notifications for the requesting account. Requires auth.

put_activity_subscription(client, body \\ %{})

Puts an activity subscription entry. The key should be omitted for creation and provided for updates. Requires auth.

put_preferences(client, body \\ %{})

Set notification-related preferences for an account. Requires auth.

put_preferences_v2(client, body \\ %{})

Set notification-related preferences for an account. Requires auth.

register_push(client, body \\ %{})

Register to receive push notifications, via a specified service, for the requesting account. Requires auth.

unregister_push(client, body \\ %{})

The inverse of registerPush - inform a specified service that push notifications should no longer be sent to the given token for the requesting account. Requires auth.

update_seen(client, body \\ %{})

Notify server that the requesting account has seen notifications. Requires auth.

Functions

get_preferences(client)

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

Get notification-related preferences for an account. Requires auth.

## Parameters

get_unread_count(client, params \\ [])

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

Count the number of unread notifications for the requesting account. Requires auth.

## Parameters

  • priority (boolean, optional)
  • seenAt (string, optional)

list_activity_subscriptions(client, params \\ [])

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

Enumerate all accounts to which the requesting account is subscribed to receive notifications for. Requires auth.

## Parameters

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

list_notifications(client, params \\ [])

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

Enumerate notifications for the requesting account. Requires auth.

## Parameters

  • cursor (string, optional)
  • limit (integer, optional)
  • priority (boolean, optional)
  • reasons (array, optional): Notification reasons to include in response.
  • seenAt (string, optional)

put_activity_subscription(client, body \\ %{})

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

Puts an activity subscription entry. The key should be omitted for creation and provided for updates. Requires auth.

put_preferences(client, body \\ %{})

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

Set notification-related preferences for an account. Requires auth.

put_preferences_v2(client, body \\ %{})

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

Set notification-related preferences for an account. Requires auth.

register_push(client, body \\ %{})

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

Register to receive push notifications, via a specified service, for the requesting account. Requires auth.

unregister_push(client, body \\ %{})

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

The inverse of registerPush - inform a specified service that push notifications should no longer be sent to the given token for the requesting account. Requires auth.

update_seen(client, body \\ %{})

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

Notify server that the requesting account has seen notifications. Requires auth.