UAInAppMessageHTMLDisplayContent

Objective-C


@interface UAInAppMessageHTMLDisplayContent : UAInAppMessageDisplayContent

Swift

class InAppMessageHTMLDisplayContent : InAppMessageDisplayContent

Display content for an HTML in-app message.

Note

This object is built using UAInAppMessageHTMLDisplayContentBuilder.
  • url

    The message’s URL.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull url;

    Swift

    var url: String { get }
  • The message’s background color.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UIColor *_Nonnull backgroundColor;

    Swift

    var backgroundColor: UIColor { get }
  • The message’s dismiss button color.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UIColor *_Nonnull dismissButtonColor;

    Swift

    var dismissButtonColor: UIColor { get }
  • The HTML message’s border radius.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGFloat borderRadiusPoints;

    Swift

    var borderRadiusPoints: CGFloat { get }
  • Flag indicating the HTML view should display as full screen on compact devices.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL allowFullScreenDisplay;

    Swift

    var allowFullScreenDisplay: Bool { get }
  • The height of the manually sized HTML view.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGFloat height;

    Swift

    var height: CGFloat { get }
  • The width of the manually sized HTML view.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGFloat width;

    Swift

    var width: CGFloat { get }
  • Flag indicating if the HTML view should lock its aspect ratio when resizing to fit the screen.

    Note

    This is only applicable when overriding the width and/or height.

    Optional. Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL aspectLock;

    Swift

    var aspectLock: Bool { get }
  • Flag indicating if the content requires connectivity to display correctly.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL requireConnectivity;

    Swift

    var requireConnectivity: Bool { get }
  • Factory method for building HTML display content with a builder block.

    Declaration

    Objective-C

    + (nullable instancetype)displayContentWithBuilderBlock:
        (nonnull void (^)(UAInAppMessageHTMLDisplayContentBuilder *_Nonnull))
            builderBlock;

    Swift

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

    Parameters

    builderBlock

    The builder block.

    Return Value

    the display content if the builder block successfully built it, otherwise nil.

  • Extends an HTML display content with a builder block.

    Declaration

    Objective-C

    - (nullable UAInAppMessageHTMLDisplayContent *)extend:
        (nonnull void (^)(UAInAppMessageHTMLDisplayContentBuilder *_Nonnull))
            builderBlock;

    Swift

    func extend(_ builderBlock: @escaping (InAppMessageHTMLDisplayContentBuilder) -> Void) -> InAppMessageHTMLDisplayContent?

    Parameters

    builderBlock

    The builder block.

    Return Value

    An extended instance of UAInAppMessageHTMLDisplayContent.