Class IterableInAppManager

Manages in-app messages for the current user.

This class provides methods to interact with in-app messages, including retrieving messages, displaying messages, removing messages, setting read status, and more.

The inAppManager property of an Iterable instance is set to an instance of this class.

Index

Constructors

constructor

Methods

getHtmlContentForMessage getInboxMessages getMessages removeMessage setAutoDisplayPaused setReadForMessage showMessage

Constructors

constructor

new IterableInAppManager(): IterableInAppManager
Returns IterableInAppManager

Methods

getHtmlContentForMessage

getHtmlContentForMessage(
message: IterableInAppMessage,
): Promise<IterableHtmlInAppContent>
Retrieve HTML in-app content for a specified in-app message.
Parameters
- message: IterableInAppMessage
  The message from which to get HTML content.
Returns Promise<IterableHtmlInAppContent>
A Promise that resolves to an IterableHtmlInAppContent object.
Example
```
Iterable.inAppManager.getHtmlContentForMessage(message);
```
- Defined in inApp/classes/IterableInAppManager.ts:151

getInboxMessages

getInboxMessages(): Promise<IterableInAppMessage[]>
Retrieves the current user's list of in-app messages designated for the mobile inbox and stored in the local queue.

This method does not cause the application to immediately check for new in-app messages on the server, since the SDK keeps the message list in sync.

Returns Promise<IterableInAppMessage[]>
A Promise that resolves to an array of messages marked as saveToInbox.
Example
```
Iterable.inAppManager.getInboxMessages().then(messages => {
   messages.forEach(message => {
     console.log(JSON.stringify(message, null, 2))
   });
});
```
- Defined in inApp/classes/IterableInAppManager.ts:61

getMessages

getMessages(): Promise<IterableInAppMessage[]>
Retrieve the current user's list of in-app messages stored in the local queue.

This method does not cause the application to immediately check for new in-app messages on the server, since the SDK keeps the message list in sync.

Returns Promise<IterableInAppMessage[]>
A Promise that resolves to an array of in-app messages.
Example
```
Iterable.inAppManager.getMessages().then(messages => {
   messages.forEach(message => {
     console.log(JSON.stringify(message, null, 2))
   });
});
```
- Defined in inApp/classes/IterableInAppManager.ts:38

removeMessage

removeMessage(
    message: IterableInAppMessage,
    location: IterableInAppLocation,
    source: IterableInAppDeleteSource,
): void
Remove the specified message from the current user's message queue.

This method calls the inAppConsume method internally.
Parameters
- message: IterableInAppMessage
  The in-app message to remove (an IterableInAppMessage object)
- location: IterableInAppLocation
  The message's location—whether or not it's in a mobile inbox. (an IterableInAppLocation enum)
- source: IterableInAppDeleteSource
  How the in-app message was deleted (an IterableInAppDeleteSource enum)
Returns void
Example
```
Iterable.inAppManager.removeMessage(
   message,
   IterableInAppLocation.inApp,
   IterableInAppDeleteSource.unknown,
);
```
- Defined in inApp/classes/IterableInAppManager.ts:112

setAutoDisplayPaused

setAutoDisplayPaused(paused: boolean): void
Pause or unpause the automatic display of incoming in-app messages

If set to false, the SDK will immediately retrieve and process in-app messages from the message queue.

The default value of isAutoDisplayPaused is false (in the native code).
Parameters
- paused: boolean
  Whether the automatic displaying should be paused
Returns void
Example
```
Iterable.inAppManager.setAutoDisplayPaused(paused);
```
- Defined in inApp/classes/IterableInAppManager.ts:173

setReadForMessage

setReadForMessage(message: IterableInAppMessage, read: boolean): void
Set the read status of specified in-app message.
Parameters
- message: IterableInAppMessage
  The message for which to set the status.
- read: boolean
  Whether the in-app message was read.
Returns void
Example
```
Iterable.inAppManager.setReadForMessage(message, true);
```
- Defined in inApp/classes/IterableInAppManager.ts:133

showMessage

showMessage(
message: IterableInAppMessage,
consume: boolean,
): Promise<undefined | string>
Renders an in-app message and consumes it from the user's message queue if necessary.

If you skip showing an in-app message when it arrives, you can show it at another time by calling this method.
Parameters
- message: IterableInAppMessage
  The message to show (an IterableInAppMessage object)
- consume: boolean
  Whether or not the message should be consumed from the user's message queue after being shown. This should be defaulted to true.
Returns Promise<undefined | string>
A Promise that resolves to the URL of the button or link the user tapped to close the in-app message.
Example
```
Iterable.inAppManager.showMessage(message, false).then(url => {
  console.log("url: " + url)
});
```
- Defined in inApp/classes/IterableInAppManager.ts:85

Class IterableInAppManager

Index

Constructors

Methods

Constructors

constructor

Returns IterableInAppManager

Methods

getHtmlContentForMessage

Parameters

Returns Promise<IterableHtmlInAppContent>

Example

getInboxMessages

Returns Promise<IterableInAppMessage[]>

Example

getMessages

Returns Promise<IterableInAppMessage[]>

Example

removeMessage

Parameters

Returns void

Example

setAutoDisplayPaused

Parameters

Returns void

Example

setReadForMessage

Parameters

Returns void

Example

showMessage

Parameters

Returns Promise<undefined | string>

Example

Settings

On This Page