com.iterable.iterableapi

Class IterableInAppManager

java.lang.Object

com.iterable.iterableapi.IterableInAppManager

All Implemented Interfaces:

IterableActivityMonitor.AppStateCallback

public class IterableInAppManager
extends java.lang.Object
implements IterableActivityMonitor.AppStateCallback

Created by David Truong dt@iterable.com. The IterableInAppManager handles creating and rendering different types of InApp Notifications received from the IterableApi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IterableInAppManager.Listener

Method Summary

Modifier and Type	Method and Description
void	addListener(IterableInAppManager.Listener listener)
java.util.List<IterableInAppMessage>	getInboxMessages() Get the list of inbox messages
java.util.List<IterableInAppMessage>	getMessages() Get the list of available in-app messages This list is synchronized with the server by the SDK
int	getUnreadInboxMessagesCount() Get the count of unread inbox messages
void	handleInAppClick(IterableInAppMessage message, android.net.Uri url)
void	notifyOnChange()
void	onSwitchToBackground()
void	onSwitchToForeground()
void	removeListener(IterableInAppManager.Listener listener)
void	removeMessage(IterableInAppMessage message) Remove message from the list
void	removeMessage(IterableInAppMessage message, IterableInAppDeleteActionType source, IterableInAppLocation clickLocation)
void	setAutoDisplayPaused(boolean paused) Set a pause to prevent showing in-app messages automatically.
void	setRead(IterableInAppMessage message, boolean read) Set the read flag on an inbox message
void	showMessage(IterableInAppMessage message) Display the in-app message on the screen
void	showMessage(IterableInAppMessage message, boolean consume, IterableHelper.IterableUrlCallback clickCallback) Display the in-app message on the screen.
void	showMessage(IterableInAppMessage message, boolean consume, IterableHelper.IterableUrlCallback clickCallback, IterableInAppLocation inAppLocation)
void	showMessage(IterableInAppMessage message, IterableInAppLocation location)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMessages

@NonNull
public java.util.List<IterableInAppMessage> getMessages()

Get the list of available in-app messages This list is synchronized with the server by the SDK

Returns:

A List of IterableInAppMessage objects

getInboxMessages

@NonNull
public java.util.List<IterableInAppMessage> getInboxMessages()

Get the list of inbox messages

Returns:

A List of IterableInAppMessage objects stored in inbox

getUnreadInboxMessagesCount

public int getUnreadInboxMessagesCount()

Get the count of unread inbox messages

Returns:

Unread inbox messages count

setRead

public void setRead(@NonNull
                    IterableInAppMessage message,
                    boolean read)

Set the read flag on an inbox message

Parameters:

message - Inbox message object retrieved from getInboxMessages()

read - Read state flag. true = read, false = unread

setAutoDisplayPaused

public void setAutoDisplayPaused(boolean paused)

Set a pause to prevent showing in-app messages automatically. By default the value is set to false.

Parameters:

paused - Whether to pause showing in-app messages.

showMessage

public void showMessage(@NonNull
                        IterableInAppMessage message)

Display the in-app message on the screen

Parameters:

message - In-App message object retrieved from getMessages()

showMessage

public void showMessage(@NonNull
                        IterableInAppMessage message,
                        @NonNull
                        IterableInAppLocation location)

showMessage

public void showMessage(@NonNull
                        IterableInAppMessage message,
                        boolean consume,
                        @Nullable
                        IterableHelper.IterableUrlCallback clickCallback)

Display the in-app message on the screen. This method, by default, assumes the current location of activity as InApp. To pass different inAppLocation as paramter, use showMessage method which takes in IterableAppLocation as a parameter.

Parameters:

message - In-App message object retrieved from getMessages()

consume - A boolean indicating whether to remove the message from the list after showing

clickCallback - A callback that is called when the user clicks on a link in the in-app message

showMessage

public void showMessage(@NonNull
                        IterableInAppMessage message,
                        boolean consume,
                        @Nullable
                        IterableHelper.IterableUrlCallback clickCallback,
                        @NonNull
                        IterableInAppLocation inAppLocation)

removeMessage

public void removeMessage(@NonNull
                          IterableInAppMessage message)

Remove message from the list

Parameters:

message - The message to be removed

removeMessage

public void removeMessage(@NonNull
                          IterableInAppMessage message,
                          @NonNull
                          IterableInAppDeleteActionType source,
                          @NonNull
                          IterableInAppLocation clickLocation)

handleInAppClick

public void handleInAppClick(@NonNull
                             IterableInAppMessage message,
                             @Nullable
                             android.net.Uri url)

onSwitchToForeground

public void onSwitchToForeground()

Specified by:

onSwitchToForeground in interface IterableActivityMonitor.AppStateCallback

onSwitchToBackground

public void onSwitchToBackground()

Specified by:

onSwitchToBackground in interface IterableActivityMonitor.AppStateCallback

addListener

public void addListener(@NonNull
                        IterableInAppManager.Listener listener)

removeListener

public void removeListener(@NonNull
                           IterableInAppManager.Listener listener)

notifyOnChange

public void notifyOnChange()