InterfaceFetchUnreadCountParams

interface FetchUnreadCountParams {
    accountId?: string;
    excludeTypes?: readonly ("follow" | "follow_request" | "admin.sign_up")[];
    groupedTypes?: readonly ("follow" | "follow_request" | "admin.sign_up")[];
    limit?: number;
    types?: readonly ("follow" | "follow_request" | "admin.sign_up")[];
}

Properties

accountId? excludeTypes? groupedTypes? limit? types?

Properties

Optional ReadonlyaccountId

accountId?: string

Only count unread notifications received from the specified account.

Optional ReadonlyexcludeTypes

excludeTypes?: readonly ("follow" | "follow_request" | "admin.sign_up")[]

Types of notifications that should not count towards unread notifications.

Optional ReadonlygroupedTypes

groupedTypes?: readonly ("follow" | "follow_request" | "admin.sign_up")[]

Restrict which notification types can be grouped. Use this if there are notification types for which your client does not support grouping. If omitted, the server will group notifications of all types it supports (currently, favourite, follow and reblog). If you do not want any notification grouping, use GET /api/v1/notifications/unread_count instead.

Optional Readonlylimit

limit?: number

Maximum number of results to return. Defaults to 100 notifications. Max 1000 notifications.

Optional Readonlytypes

types?: readonly ("follow" | "follow_request" | "admin.sign_up")[]

Types of notifications that should count towards unread notifications.

Settings

Member Visibility

On This Page

Properties