Inherits from NSObject
Declared in UAInAppMessaging.h

Overview

Manager class for in-app messaging.

Properties

autoDisplayEnabled

Enables/disables auto-display of in-app messages.

@property (nonatomic, assign, getter=isAutoDisplayEnabled) BOOL autoDisplayEnabled

Declared In

UAInAppMessaging.h

defaultPrimaryColor

The default primary color for messages (background and button color). Colors sent in an in-app message payload will override this setting. Defaults to white.

@property (nonatomic, strong) UIColor *defaultPrimaryColor

Declared In

UAInAppMessaging.h

defaultSecondaryColor

The default secondary color for messages (text and border color). Colors sent in an in-app message payload will override this setting. Defaults to gray (#282828).

@property (nonatomic, strong) UIColor *defaultSecondaryColor

Declared In

UAInAppMessaging.h

displayASAPEnabled

Whether to display an incoming message as soon as possible, as opposed to on app foreground transitions. If set to YES, and if automatic display is enabled, when a message arrives in the foreground it will be automatically displayed as soon as it has been received. Otherwise the message will be stored as pending. Defaults to NO.

@property (nonatomic, assign, getter=isDisplayASAPEnabled) BOOL displayASAPEnabled

Declared In

UAInAppMessaging.h

displayDelay

The initial delay before displaying an in-app message. The timer begins when the application becomes active. Defaults to 3 seconds.

@property (nonatomic, assign) NSTimeInterval displayDelay

Declared In

UAInAppMessaging.h

font

The desired font to use when displaying in-app messages. Defaults to a bold system font 12 points in size.

@property (nonatomic, strong) UIFont *font

Declared In

UAInAppMessaging.h

messageControllerDelegate

A optional delegate for configuring and providing custom UI during message display.

@property (nonatomic, weak, nullable) id<UAInAppMessageControllerDelegate> messageControllerDelegate

Declared In

UAInAppMessaging.h

messagingDelegate

An optional delegate to receive in-app messaging related callbacks.

@property (nonatomic, weak, nullable) id<UAInAppMessagingDelegate> messagingDelegate

Declared In

UAInAppMessaging.h

pendingMessage

The pending in-app message.

@property (nonatomic, copy, nullable) UAInAppMessage *pendingMessage

Declared In

UAInAppMessaging.h

Instance Methods

deletePendingMessage:

Deletes the pending message if it matches the provided message argument.

- (void)deletePendingMessage:(UAInAppMessage *)message

Parameters

message

The message to delete.

Declared In

UAInAppMessaging.h

displayMessage:

Displays the provided message. Expired messages will be ignored.

- (void)displayMessage:(UAInAppMessage *)message

Parameters

message

The message to display.

Declared In

UAInAppMessaging.h