Class IterableInboxDataModel

constructor

• new IterableInboxDataModel(): IterableInboxDataModel

  Returns IterableInboxDataModel

OptionalcomparatorFn

OptionaldateMapperFn

OptionalfilterFn

deleteItemById

• deleteItemById(id: string, deleteSource: IterableInAppDeleteSource): void

  Deletes an item from the inbox by its ID.

  Parameters

  • id: string

    The unique identifier of the item to be deleted.

  • deleteSource: IterableInAppDeleteSource

    The source from which the delete action is initiated.

  Returns void

endSession

• endSession(visibleRows?: IterableInboxImpressionRowInfo[]): Promise<void>

  Ends the current tracking session and updates the visible rows.

  Parameters

  • visibleRows: IterableInboxImpressionRowInfo[] = []

    An array of IterableInboxImpressionRowInfo objects representing the rows that are currently visible. Defaults to an empty array.

  Returns Promise<void>

  A promise that resolves when the session has ended and the visible rows have been updated.

getFormattedDate

• getFormattedDate(message: IterableInAppMessage): undefined | string

  Formats the creation date of an in-app message.

  Parameters

  • message: IterableInAppMessage

    The in-app message object containing the creation date.

  Returns undefined | string

  The formatted date string. Returns an empty string if the creation date is undefined.

getHtmlContentForMessageId

• getHtmlContentForMessageId(id: string): Promise<IterableHtmlInAppContent>

  Retrieves the HTML content for a given message ID.

  Parameters

  • id: string

    The ID of the message to retrieve HTML content for.

  Returns Promise<IterableHtmlInAppContent>

  A promise that resolves to the HTML content of the specified message.

refresh

• refresh(): Promise<IterableInboxRowViewModel[]>

  Refreshes the inbox data by fetching the latest messages from Iterable.

  Returns Promise<IterableInboxRowViewModel[]>

  A promise that resolves to an array of processed inbox row view models. If the fetch operation fails, the promise resolves to an empty array.

set

• set(
      filter?: (message: IterableInAppMessage) => boolean,
      comparator?: (
          message1: IterableInAppMessage,
          message2: IterableInAppMessage,
      ) => number,
      dateMapper?: (message: IterableInAppMessage) => undefined | string,
  ): void

  Sets the filter, comparator, and date mapper functions for the inbox data model.

  Parameters

  • Optionalfilter: (message: IterableInAppMessage) => boolean

    A function to filter messages. It takes an IterableInAppMessage as an argument and returns a boolean indicating whether the message should be included.

  • Optionalcomparator: (message1: IterableInAppMessage, message2: IterableInAppMessage) => number

    A function to compare two messages. It takes two IterableInAppMessage objects as arguments and returns a number indicating their relative order.

  • OptionaldateMapper: (message: IterableInAppMessage) => undefined | string

    A function to map a message to a date string. It takes an IterableInAppMessage as an argument and returns a string representing the date, or undefined if no date is applicable.

  Returns void

setMessageAsRead

• setMessageAsRead(id: string): void

  Marks a message as read in the Iterable inbox.

  Parameters

  • id: string

    The unique identifier of the message to be marked as read.

  Returns void

startSession

• startSession(visibleRows?: IterableInboxImpressionRowInfo[]): void

  Starts a tracking session for the inbox with the given visible rows.

  Parameters

  • visibleRows: IterableInboxImpressionRowInfo[] = []

    An array of IterableInboxImpressionRowInfo objects representing the rows that are currently visible.

  Returns void

updateVisibleRows

• updateVisibleRows(visibleRows?: IterableInboxImpressionRowInfo[]): void

  Updates the visible rows in the inbox.

  This method takes an array of IterableInboxImpressionRowInfo objects representing the rows that are currently visible and updates the visibility status. (REVIEW: Where does it update it? In Iterable or in the interface?)

  Parameters

  • visibleRows: IterableInboxImpressionRowInfo[] = []

    An array of IterableInboxImpressionRowInfo objects representing the rows that are currently visible. Defaults to an empty array if not provided.

  Returns void