UAInAppMessageBuilder

@interface UAInAppMessageBuilder : NSObject

Builder class for UAInAppMessage.

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

    Required.

    Declaration

    Objective-C

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

    Swift

    var identifier: String? { get set }
  • Message name. Optional. Must be between [1-100] characters.

    Declaration

    Objective-C

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

    Swift

    var name: String? { get set }
  • The display content for the message.

    Required.

    Declaration

    Objective-C

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

    Swift

    var displayContent: UAInAppMessageDisplayContent? { get set }
  • Extra information for the message.

    Optional.

    Declaration

    Objective-C

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

    Swift

    var extras: [AnyHashable : Any]? { get set }
  • The display actions for the message.

    Optional.

    Declaration

    Objective-C

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

    Swift

    var actions: [AnyHashable : Any]? { get set }
  • The audience conditions for the message.

    Optional.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        UAInAppMessageAudience *audience;

    Swift

    var audience: UAInAppMessageAudience? { get set }
  • Display behavior. Defaults to UAInAppMessageDisplayBehaviorDefault.

    Declaration

    Objective-C

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

    Swift

    var displayBehavior: String? { get set }
  • Flag indicating if reporting is enabled. Defaults to NO.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL isReportingEnabled;

    Swift

    var isReportingEnabled: Bool { get set }
  • Checks if the builder is valid and will produce a message instance. - returns: YES if the builder is valid (requires display content and an ID), otherwise NO.

    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.