Inherits from NSObject
Declared in UAInAppMessage.h

Overview

Model object representing in-app message data.

Properties

alert

The alert message.

@property (nonatomic, copy, nullable) NSString *alert

Declared In

UAInAppMessage.h

buttonActionBindings

An array of UAInAppMessageButtonActionBinding instances, corresponding to the left-to-right order of interactive message buttons.

@property (nonatomic, readonly, nullable) NSArray *buttonActionBindings

Declared In

UAInAppMessage.h

buttonActions

A dictionary mapping button group keys to dictionaries mapping action names to action arguments. The relevant action(s) will be run when the user taps the associated button.

@property (nonatomic, copy, nullable) NSDictionary *buttonActions

Declared In

UAInAppMessage.h

buttonCategory

A UAUserNotificationCategory instance, corresponding to to the button group of the message. If no matching category is found, this property will be nil.

@property (nonatomic, readonly, nullable) UAUserNotificationCategory *buttonCategory

Declared In

UAInAppMessage.h

buttonGroup

The button group (category) associated with the message. This value will determine which buttons are present and their localized titles.

@property (nonatomic, copy, nullable) NSString *buttonGroup

Declared In

UAInAppMessage.h

displayType

The display type. Defaults to UAInAppMessageDisplayTypeBanner when built with the default class constructor, or UAInAppMessageDisplayTypeUnknown when built from a payload with a missing or unidentified display type.

@property (nonatomic, assign) UAInAppMessageDisplayType displayType

Declared In

UAInAppMessage.h

duration

The amount of time to wait before automatically dismissing the message.

@property (nonatomic, assign) NSTimeInterval duration

Declared In

UAInAppMessage.h

expiry

The expiration date for the message. Unless otherwise specified, defaults to 30 days from construction.

@property (nonatomic, strong) NSDate *expiry

Declared In

UAInAppMessage.h

extra

Optional key value extras.

@property (nonatomic, copy, nullable) NSDictionary *extra

Declared In

UAInAppMessage.h

identifier

The unique identifier for the message (to be set from the associated send ID)

@property (nonatomic, copy, nullable) NSString *identifier

Declared In

UAInAppMessage.h

notificationActionContext

The chosen notification action context. If there are notification actions defined for UIUserNotificationActionContextMinimal, this context will be preferred. Othwerise, the context defaults to UIUserNotificationActionContextDefault.

@property (nonatomic, readonly) UIUserNotificationActionContext notificationActionContext

Declared In

UAInAppMessage.h

notificationActions

An array of UAUserNotificationAction instances corresponding to the left-to-right order of interactive message buttons.

@property (nonatomic, readonly, nullable) NSArray *notificationActions

Declared In

UAInAppMessage.h

onClick

A dictionary mapping an action name to an action argument. The relevant action will be run when the user taps or “clicks” on the message.

@property (nonatomic, copy, nullable) NSDictionary *onClick

Declared In

UAInAppMessage.h

payload

The in-app message payload in NSDictionary format

@property (nonatomic, readonly) NSDictionary *payload

Declared In

UAInAppMessage.h

position

The screen position. Defaults to UAInAppMessagePositionBottom.

@property (nonatomic, assign) UAInAppMessagePosition position

Declared In

UAInAppMessage.h

primaryColor

The primary color.

@property (nonatomic, strong, nullable) UIColor *primaryColor

Declared In

UAInAppMessage.h

secondaryColor

The secondary color.

@property (nonatomic, strong, nullable) UIColor *secondaryColor

Declared In

UAInAppMessage.h

Class Methods

message

Class factory method for constructing an unconfigured in-app message model.

+ (instancetype)message

Return Value

An unconfigured instance of UAInAppMessage.

Declared In

UAInAppMessage.h

messageWithPayload:

Class factory method for constructing an in-app message model from the in-app message section of a push payload.

+ (instancetype)messageWithPayload:(NSDictionary *)payload

Parameters

payload

The in-app message section of a push payload, in NSDictionary representation.

Return Value

A fully configured instance of UAInAppMessage.

Declared In

UAInAppMessage.h

Instance Methods

isEqualToMessage:

Tests whether the message is equal by value to another message.

- (BOOL)isEqualToMessage:(nullable UAInAppMessage *)message

Parameters

message

The message the receiver is being compared to.

Return Value

YES if the two messages are equal by value, NO otherwise.

Declared In

UAInAppMessage.h