Interface NotificationsResource

policy

unreadCount

$select

• $select(groupKey: string): mastodon.rest.v2.Notifications$SelectResource

  Parameters

  • groupKey: string

    The group key of the notification group.

  Returns mastodon.rest.v2.Notifications$SelectResource

list

• list(
      params?: mastodon.rest.v2.ListNotificationsParams,
      meta?: HttpMetaParams<"none">,
  ): Paginator<GroupedNotificationsResults>

  Return grouped 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.

  Notifications of type favourite, follow or reblog with the same type and the same target made in a similar timeframe are given a same group_key by the server, and querying this endpoint will return aggregated notifications, with only one object per group_key. Other notification types may be grouped in the future. The grouped_types parameter should be used by the client to explicitly list the types it supports showing grouped notifications for.

  Parameters

  • Optionalparams: mastodon.rest.v2.ListNotificationsParams
  • Optionalmeta: HttpMetaParams<"none">

  Returns Paginator<GroupedNotificationsResults>