UAInAppMessageBuilder

Objective-C

@interface UAInAppMessageBuilder : NSObject

Swift

class UAInAppMessageBuilder : NSObject

Builder class for UAInAppMessage.

In App Message Builder Properties

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

    Declaration

    Objective-C

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

    Swift

    var name: String? { get set }

  • The display content for the message.

    Required.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UAInAppMessageDisplayContent *displayContent;

    Swift

    var displayContent: InAppMessageDisplayContent? { get set }

  • Extra information for the message.

    Optional.

    Declaration

    Objective-C

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

    Swift

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

  • The display actions for the message.

    Optional.

    Declaration

    Objective-C

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

    Swift

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

  • Display behavior. Defaults to UAInAppMessageDisplayBehaviorDefault.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *displayBehavior;

    Swift

    var displayBehavior: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL isReportingEnabled;

    Swift

    var isReportingEnabled: Bool { get set }

  • Checks if the builder is valid and will produce a message instance.

    Declaration

    Objective-C

    - (BOOL)isValid;

    Swift

    func isValid() -> Bool

    Return Value

    YES if the builder is valid (requires display content and an ID), otherwise NO.