Interface ListNotificationsParams

interface ListNotificationsParams {
    accountId?: null | string;
    excludeTypes?: null | readonly ("mention" | "status" | "reblog" | "follow" | "follow_request" | "favourite" | "poll" | "update" | "admin.sign_up" | "admin.report")[];
    limit?: null | number;
    maxId?: null | string;
    minId?: null | string;
    sinceId?: null | string;
    types?: null | readonly ("mention" | "status" | "reblog" | "follow" | "follow_request" | "favourite" | "poll" | "update" | "admin.sign_up" | "admin.report")[];
}

Hierarchy (view full)

Properties

accountId? excludeTypes? limit? maxId? minId? sinceId? types?

Properties

Optional Readonly accountId

accountId?: null | string

ID of the account

Optional Readonly excludeTypes

excludeTypes?: null | readonly ("mention" | "status" | "reblog" | "follow" | "follow_request" | "favourite" | "poll" | "update" | "admin.sign_up" | "admin.report")[]

Array of notifications to exclude (Allowed values: "follow", "favourite", "reblog", "mention")

Optional Readonly limit

limit?: null | number

Maximum number of results to return per page. Defaults to 40. NOTE: Pagination is done with the Link header from the response.

Optional Readonly maxId

maxId?: null | string

Return results older than this ID.

Optional Readonly minId

minId?: null | string

Get a list of items with ID greater than this value excluding this ID

Optional Readonly sinceId

sinceId?: null | string

Return results newer than this ID.

Optional Readonly types

types?: null | readonly ("mention" | "status" | "reblog" | "follow" | "follow_request" | "favourite" | "poll" | "update" | "admin.sign_up" | "admin.report")[]

Instead of specifying every known type to exclude, you can specify only the types you want.

Settings

Member Visibility

Theme

On This Page

accountIdexcludeTypeslimitmaxIdminIdsinceIdtypes