Class BatchInboxFetcher

Index

Constructors

Methods

destroy displayNotificationLandingMessage fetchNewNotifications fetchNextPage hasMore markAllNotificationsAsRead markNotificationAsDeleted markNotificationAsRead

Constructors

constructor

new BatchInboxFetcher(identifier): BatchInboxFetcher
Parameters
- identifier: string
Returns BatchInboxFetcher
- Defined in BatchInboxFetcher.ts:9

Methods

destroy

destroy(): Promise<void>
Destroys the fetcher.

You'll usually want to use this when your component unmounts in order to free up memory.

Returns Promise<void>
- Defined in BatchInboxFetcher.ts:18

displayNotificationLandingMessage

displayNotificationLandingMessage(notificationIdentifier): Promise<void>
Display the landing message attached to the notification.

The notification must have been fetched by this fetcher before.
Parameters
- notificationIdentifier: string
  The identifier of the notification to display
Returns Promise<void>
- Defined in BatchInboxFetcher.ts:65

fetchNewNotifications

fetchNewNotifications(): Promise<{
    endReached: boolean;
    foundNewNotifications: boolean;
    notifications: IInboxNotification[];
}>
Fetches new notifications (and resets pagination to 0).

Usually used as an initial fetch and refresh method in an infinite list.

Returns Promise<{
    endReached: boolean;
    foundNewNotifications: boolean;
    notifications: IInboxNotification[];
}>
- Defined in BatchInboxFetcher.ts:74

fetchNextPage

fetchNextPage(): Promise<{
endReached: boolean;
notifications: IInboxNotification[];
}>
Fetches the next page of notifications.

Usually used as a "fetchMore" method in an infinite list.

Returns Promise<{
endReached: boolean;
notifications: IInboxNotification[];
}>
- Defined in BatchInboxFetcher.ts:90

hasMore

hasMore(): Promise<boolean>
Returns whether there is more notification to fetch.

Returns Promise<boolean>
- Defined in BatchInboxFetcher.ts:25

markAllNotificationsAsRead

markAllNotificationsAsRead(): Promise<void>
Marks all notifications as read.

Returns Promise<void>
- Defined in BatchInboxFetcher.ts:32

markNotificationAsDeleted

markNotificationAsDeleted(notificationIdentifier): Promise<void>
Marks a notification as deleted.

The notification must have been fetched by this fetcher before.
Parameters
- notificationIdentifier: string
  The identifier of the notification to mark as deleted
Returns Promise<void>
- Defined in BatchInboxFetcher.ts:54

markNotificationAsRead

markNotificationAsRead(notificationIdentifier): Promise<void>
Marks a notification as read.

The notification must have been fetched by this fetcher before.
Parameters
- notificationIdentifier: string
  The identifier of the notification to mark as read
Returns Promise<void>
- Defined in BatchInboxFetcher.ts:43