Interface NotificationRepository

interface NotificationRepository {
    $select(id): {
        dismiss(meta?): Promise<void>;
        fetch(meta?): Promise<Notification>;
    };
    clear(meta?): Promise<void>;
    list(params?, meta?): Paginator<Notification[], ListNotificationsParams>;
}

Index

Methods

$select clear list

Methods

$select

$select(id): {
dismiss(meta?): Promise<void>;
fetch(meta?): Promise<Notification>;
}
Parameters
- id: string
Returns {
dismiss(meta?): Promise<void>;
fetch(meta?): Promise<Notification>;
}
- dismiss:function
  - dismiss(meta?): Promise<void>
  - Clear a single notification from the server.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<void>
    N/A
    
    See
    https://docs.joinmastodon.org/methods/notifications/
    - Defined in src/mastodon/rest/v1/notification-repository.ts:42
- fetch:function
  - fetch(meta?): Promise<Notification>
  - View information about a notification with a given ID.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Notification>
    Notification
    
    See
    https://docs.joinmastodon.org/methods/notifications/
    - Defined in src/mastodon/rest/v1/notification-repository.ts:35
- Defined in src/mastodon/rest/v1/notification-repository.ts:29

clear

clear(meta?): Promise<void>
Clear all notifications from the server.
Parameters
- Optional meta: HttpMetaParams<"none">
Returns Promise<void>
N/A

See
https://docs.joinmastodon.org/methods/notifications/
- Defined in src/mastodon/rest/v1/notification-repository.ts:50

list

list(params?, meta?): Paginator<Notification[], ListNotificationsParams>
Notifications concerning the user. This API returns Link headers containing links to the next/previous page. However, the links can also be constructed dynamically using query params and id values.
Parameters
- Optional params: ListNotificationsParams
  Query parameter
- Optional meta: HttpMetaParams<"json">
Returns Paginator<Notification[], ListNotificationsParams>
Array of Notification

See
https://docs.joinmastodon.org/methods/notifications/
- Defined in src/mastodon/rest/v1/notification-repository.ts:24

Interface NotificationRepository

Index

Methods

Methods

$select

Parameters

Returns {
dismiss(meta?): Promise<void>;
fetch(meta?): Promise<Notification>;
}

dismiss:function

Parameters

Returns Promise<void>

See

fetch:function

Parameters

Returns Promise<Notification>

See

clear

Parameters

Returns Promise<void>

See

list

Parameters

Returns Paginator<Notification[], ListNotificationsParams>

See

Settings

Member Visibility

Theme

On This Page

Interface NotificationRepository

Index

Methods

Methods

$select

Parameters

Returns { dismiss(meta?): Promise<void>; fetch(meta?): Promise<Notification>; }

dismiss:function

Parameters

Returns Promise<void>

See

fetch:function

Parameters

Returns Promise<Notification>

See

clear

Parameters

Returns Promise<void>

See

list

Parameters

Returns Paginator<Notification[], ListNotificationsParams>

See

Settings

Member Visibility

Theme

On This Page

Returns {
dismiss(meta?): Promise<void>;
fetch(meta?): Promise<Notification>;
}