UAInAppMessage

Objective-C


@interface UAInAppMessage : NSObject

Swift

class InAppMessage : NSObject

Model object representing in-app message data.

Note

This object is built using UAInAppMessageBuilder.

In App Message Properties

  • Message name. Optional. Must be between [1-100] characters.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *name;

    Swift

    var name: String? { get }

  • The display type.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UAInAppMessageDisplayType displayType;

    Swift

    var displayType: InAppMessageDisplayType { get }

  • The display content for the message.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UAInAppMessageDisplayContent *_Nonnull displayContent;

    Swift

    var displayContent: InAppMessageDisplayContent { get }

  • Extra information for the message.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDictionary *extras;

    Swift

    var extras: [AnyHashable : Any]? { get }

  • Display actions.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDictionary *actions;

    Swift

    var actions: [AnyHashable : Any]? { get }

  • Display behavior. Defaults to UAInAppMessageDisplayBehaviorDefault.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull displayBehavior;

    Swift

    var displayBehavior: String { get }

  • Flag indicating if reporting is enabled. Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isReportingEnabled;

    Swift

    var isReportingEnabled: Bool { get }

In App Message Methods

  • Class factory method for constructing an in-app message model with an in-app message builder block.

    Declaration

    Objective-C

    + (nullable instancetype)messageWithBuilderBlock:
    (nonnull void (^)(UAInAppMessageBuilder *_Nonnull))builderBlock;

    Swift

    convenience init?(builderBlock: @escaping (UAInAppMessageBuilder) -> Void)

    Parameters

    builderBlock

    the builder block.

    Return Value

    A fully configured instance of UAInAppMessage.

  • Extends a message with a builder block.

    Declaration

    Objective-C

    - (nullable UAInAppMessage *)extend:
    (nonnull void (^)(UAInAppMessageBuilder *_Nonnull))builderBlock;

    Swift

    func extend(_ builderBlock: @escaping (UAInAppMessageBuilder) -> Void) -> InAppMessage?

    Parameters

    builderBlock

    The builder block.

    Return Value

    An extended instance of UAInAppMessage.