(notifications)
- getUnreadCount - This endpoint is part of the Bluesky application Lexicon APIs (
app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Count the number of unread notifications for the requesting account. Requires auth.
- putPreferences - This endpoint is part of the Bluesky application Lexicon APIs (
app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Set notification-related preferences for an account. Requires auth.
- registerPush - This endpoint is part of the Bluesky application Lexicon APIs (
app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Register to receive push notifications, via a specified service, for the requesting account. Requires auth.
- updateSeen - This endpoint is part of the Bluesky application Lexicon APIs (
app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Notify server that the requesting account has seen notifications. Requires auth.
This endpoint is part of the Bluesky application Lexicon APIs (app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Count the number of unread notifications for the requesting account. Requires auth.
import { Bluesky } from "@speakeasy-api/bluesky";
const bluesky = new Bluesky({
bearer: process.env["BLUESKY_BEARER"] ?? "",
});
async function run() {
const result = await bluesky.notifications.getUnreadCount();
// Handle the result
console.log(result);
}
run();The standalone function version of this method:
import { BlueskyCore } from "@speakeasy-api/bluesky/core.js";
import { notificationsGetUnreadCount } from "@speakeasy-api/bluesky/funcs/notificationsGetUnreadCount.js";
// Use `BlueskyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const bluesky = new BlueskyCore({
bearer: process.env["BLUESKY_BEARER"] ?? "",
});
async function run() {
const res = await notificationsGetUnreadCount(bluesky);
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useNotificationsGetUnreadCount,
useNotificationsGetUnreadCountSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchNotificationsGetUnreadCount,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateNotificationsGetUnreadCount,
invalidateAllNotificationsGetUnreadCount,
} from "@speakeasy-api/bluesky/react-query/notificationsGetUnreadCount.js";| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.AppBskyNotificationGetUnreadCountRequest | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.AppBskyNotificationGetUnreadCountResponseBody>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.AppBskyNotificationGetUnreadCountResponseBody | 400 | application/json |
| errors.AppBskyNotificationGetUnreadCountNotificationsResponseBody | 401 | application/json |
| errors.Unauthorized | 403, 407, 511 | application/json |
| errors.NotFound | 404, 501, 505 | application/json |
| errors.Timeout | 408, 504 | application/json |
| errors.BadRequest | 413, 414, 415, 422, 431, 510 | application/json |
| errors.RateLimited | 429 | application/json |
| errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
| errors.APIError | 4XX, 5XX | */* |
This endpoint is part of the Bluesky application Lexicon APIs (app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Set notification-related preferences for an account. Requires auth.
import { Bluesky } from "@speakeasy-api/bluesky";
const bluesky = new Bluesky({
bearer: process.env["BLUESKY_BEARER"] ?? "",
});
async function run() {
await bluesky.notifications.putPreferences({
priority: true,
});
}
run();The standalone function version of this method:
import { BlueskyCore } from "@speakeasy-api/bluesky/core.js";
import { notificationsPutPreferences } from "@speakeasy-api/bluesky/funcs/notificationsPutPreferences.js";
// Use `BlueskyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const bluesky = new BlueskyCore({
bearer: process.env["BLUESKY_BEARER"] ?? "",
});
async function run() {
const res = await notificationsPutPreferences(bluesky, {
priority: true,
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
}
run();This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useNotificationsPutPreferencesMutation
} from "@speakeasy-api/bluesky/react-query/notificationsPutPreferences.js";| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.AppBskyNotificationPutPreferencesRequestBody | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<void>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.AppBskyNotificationPutPreferencesResponseBody | 400 | application/json |
| errors.AppBskyNotificationPutPreferencesNotificationsResponseBody | 401 | application/json |
| errors.Unauthorized | 403, 407, 511 | application/json |
| errors.NotFound | 404, 501, 505 | application/json |
| errors.Timeout | 408, 504 | application/json |
| errors.BadRequest | 413, 414, 415, 422, 431, 510 | application/json |
| errors.RateLimited | 429 | application/json |
| errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
| errors.APIError | 4XX, 5XX | */* |
This endpoint is part of the Bluesky application Lexicon APIs (app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Register to receive push notifications, via a specified service, for the requesting account. Requires auth.
import { Bluesky } from "@speakeasy-api/bluesky";
const bluesky = new Bluesky({
bearer: process.env["BLUESKY_BEARER"] ?? "",
});
async function run() {
await bluesky.notifications.registerPush({
serviceDid: "<id>",
token: "<value>",
platform: "ios",
appId: "<id>",
});
}
run();The standalone function version of this method:
import { BlueskyCore } from "@speakeasy-api/bluesky/core.js";
import { notificationsRegisterPush } from "@speakeasy-api/bluesky/funcs/notificationsRegisterPush.js";
// Use `BlueskyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const bluesky = new BlueskyCore({
bearer: process.env["BLUESKY_BEARER"] ?? "",
});
async function run() {
const res = await notificationsRegisterPush(bluesky, {
serviceDid: "<id>",
token: "<value>",
platform: "ios",
appId: "<id>",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
}
run();This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useNotificationsRegisterPushMutation
} from "@speakeasy-api/bluesky/react-query/notificationsRegisterPush.js";| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.AppBskyNotificationRegisterPushRequestBody | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<void>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.AppBskyNotificationRegisterPushResponseBody | 400 | application/json |
| errors.AppBskyNotificationRegisterPushNotificationsResponseBody | 401 | application/json |
| errors.Unauthorized | 403, 407, 511 | application/json |
| errors.NotFound | 404, 501, 505 | application/json |
| errors.Timeout | 408, 504 | application/json |
| errors.BadRequest | 413, 414, 415, 422, 431, 510 | application/json |
| errors.RateLimited | 429 | application/json |
| errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
| errors.APIError | 4XX, 5XX | */* |
This endpoint is part of the Bluesky application Lexicon APIs (app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Notify server that the requesting account has seen notifications. Requires auth.
import { Bluesky } from "@speakeasy-api/bluesky";
const bluesky = new Bluesky({
bearer: process.env["BLUESKY_BEARER"] ?? "",
});
async function run() {
await bluesky.notifications.updateSeen({
seenAt: new Date("2023-05-09T15:02:30.758Z"),
});
}
run();The standalone function version of this method:
import { BlueskyCore } from "@speakeasy-api/bluesky/core.js";
import { notificationsUpdateSeen } from "@speakeasy-api/bluesky/funcs/notificationsUpdateSeen.js";
// Use `BlueskyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const bluesky = new BlueskyCore({
bearer: process.env["BLUESKY_BEARER"] ?? "",
});
async function run() {
const res = await notificationsUpdateSeen(bluesky, {
seenAt: new Date("2023-05-09T15:02:30.758Z"),
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
}
run();This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useNotificationsUpdateSeenMutation
} from "@speakeasy-api/bluesky/react-query/notificationsUpdateSeen.js";| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.AppBskyNotificationUpdateSeenRequestBody | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<void>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.AppBskyNotificationUpdateSeenResponseBody | 400 | application/json |
| errors.AppBskyNotificationUpdateSeenNotificationsResponseBody | 401 | application/json |
| errors.Unauthorized | 403, 407, 511 | application/json |
| errors.NotFound | 404, 501, 505 | application/json |
| errors.Timeout | 408, 504 | application/json |
| errors.BadRequest | 413, 414, 415, 422, 431, 510 | application/json |
| errors.RateLimited | 429 | application/json |
| errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
| errors.APIError | 4XX, 5XX | */* |