Class BatchInboxFetcherInstallationImplementation

Hierarchy

  • BatchInboxFetcherBaseImplementation
    • BatchInboxFetcherInstallationImplementation

Constructors

constructor

Properties

_fetcherID?

Methods

_makeBaseBridgeParameters _makeBaseInitParameters _parseBridgeNotification _parseBridgeNotifications _throwIfDisposed displayNotificationLandingMessage dispose fetchNewNotifications fetchNextPage getAllFetchedNotifications init markAllNotificationsAsRead markNotificationAsDeleted markNotificationAsRead

Constructors

constructor

Properties

Protected Optional_fetcherID

_fetcherID?: string

Methods

Protected_makeBaseBridgeParameters

  • _makeBaseBridgeParameters(): {
        [key: string]: string;
    }

  • Returns {
        [key: string]: string;
    }

    • [key: string]: string

Protected_makeBaseInitParameters

  • _makeBaseInitParameters(maxPageSize?, limit?): {
        limit?: number;
        maxPageSize?: number;
    }

  • Parameters

    • OptionalmaxPageSize: number
    • Optionallimit: number

    Returns {
        limit?: number;
        maxPageSize?: number;
    }

    • Optionallimit?: number
    • OptionalmaxPageSize?: number

Protected_parseBridgeNotification

  • _parseBridgeNotification(notif): InboxNotification

  • Parameters

    • notif: {
          [key: string]: unknown;
      }
      • [key: string]: unknown

    Returns InboxNotification

Protected_parseBridgeNotifications

  • _parseBridgeNotifications(response): InboxNotification[]

  • Parameters

    • response: [{
          [key: string]: unknown;
      }]

    Returns InboxNotification[]

Protected_throwIfDisposed

  • _throwIfDisposed(): Promise<void>

  • Returns Promise<void>

displayNotificationLandingMessage

  • displayNotificationLandingMessage(notification): Promise<void>

  • Display the landing message attached to the notification.

    Does nothing when no landing message is attached.

    Parameters

    • notification: InboxNotification

    Returns Promise<void>

dispose

  • dispose(): void

  • Call this once you're finished with this fetcher to release the native object and free all memory. Usually, this should be called in your State's dispose. Due to javascript limitations, not calling this will leak memory.

    Calling any method after calling dispose will result in an error being thrown.

    Returns void

fetchNewNotifications

  • fetchNewNotifications(): Promise<InboxFetchResult>

  • Fetch new notifications. While () is used to fetch older notifications than the ones currently loaded, this method checks for new notifications. For example, this is the method you would call on initial load, or on a "pull to refresh". The previously loaded notifications will be cleared to ensure consistency. Otherwise, a gap could be created between new notifications and your current set. Upon calling this method, please clear your cache and fill it with this method's results and ask again for more pages if you need.

    Returns Promise<InboxFetchResult>

fetchNextPage

  • fetchNextPage(): Promise<InboxFetchResult>

  • Fetch a page of notifications. Calling this method when no messages have been loaded will be equivalent to calling ()

    Returns Promise<InboxFetchResult>

getAllFetchedNotifications

  • getAllFetchedNotifications(): Promise<InboxNotification[]>

  • Get all of the notifications that have been fetched by this fetcher instance.

    Note: This doesn't cache anything on the javascript side, but always asks the native code. Therefore, this is an expensive method to call: you should cache the result on your end.

    Returns Promise<InboxNotification[]>

init

  • init(maxPageSize?, limit?): Promise<void>

  • Parameters

    • OptionalmaxPageSize: number
    • Optionallimit: number

    Returns Promise<void>

markAllNotificationsAsRead

  • markAllNotificationsAsRead(): Promise<void>

  • Marks all notifications as read. Note: Please refresh your copy of the notifications using [allNotifications] to update the read status. Calling [fetchNewNotifications()]/[fetchNextPage()] right away might cause notifications to come as unread, as the server needs time to process your request.

    Returns Promise<void>

markNotificationAsDeleted

  • markNotificationAsDeleted(notification): Promise<void>

  • Marks a notification as deleted.

    Calling [fetchNewNotifications()]/[fetchNextPage()] right away might cause notifications to still be present, as the server needs time to process your request.

    Parameters

    • notification: InboxNotification

    Returns Promise<void>

markNotificationAsRead

  • markNotificationAsRead(notification): Promise<void>

  • Marks a notification as read.

    Note: Please refresh your copy of the notifications using [allNotifications] to update the read status. Calling [fetchNewNotifications()]/[fetchNextPage()] right away might cause notifications to come as unread, as the server needs time to process your request.

    Parameters

    • notification: InboxNotification

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods