UAInAppMessageBannerDisplayContent

Objective-C


@interface UAInAppMessageBannerDisplayContent : UAInAppMessageDisplayContent

Swift

class InAppMessageBannerDisplayContent : InAppMessageDisplayContent

Display content for a banner in-app message.

Note

This object is built using UAInAppMessageBannerDisplayContentBuilder.
  • The banner’s heading.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) UAInAppMessageTextInfo *heading;

    Swift

    var heading: InAppMessageTextInfo? { get }
  • The banner’s body.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) UAInAppMessageTextInfo *body;

    Swift

    var body: InAppMessageTextInfo? { get }
  • The banner’s media.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) UAInAppMessageMediaInfo *media;

    Swift

    var media: InAppMessageMediaInfo? { get }
  • The banner’s buttons.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<UAInAppMessageButtonInfo *> *_Nonnull buttons;

    Swift

    var buttons: [InAppMessageButtonInfo] { get }
  • The banner’s button layout. Defaults to UAInAppMessageButtonLayoutSeparate.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UAInAppMessageButtonLayoutType buttonLayout;

    Swift

    var buttonLayout: InAppMessageButtonLayoutType { get }
  • The banner’s placement.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UAInAppMessageBannerPlacementType placement;

    Swift

    var placement: InAppMessageBannerPlacementType { get }
  • The banner’s layout for the text and media.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UAInAppMessageBannerContentLayoutType contentLayout;

    Swift

    var contentLayout: InAppMessageBannerContentLayoutType { get }
  • The banner’s display duration in seconds.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSTimeInterval durationSeconds;

    Swift

    var durationSeconds: TimeInterval { get }
  • The banner’s background color.

    Declaration

    Objective-C

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

    Swift

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

    Declaration

    Objective-C

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

    Swift

    var dismissButtonColor: UIColor { get }
  • The banner’s border radius in points.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGFloat borderRadiusPoints;

    Swift

    var borderRadiusPoints: CGFloat { get }
  • The banner’s actions. Only supported for Legacy In-App Messaging.

    Declaration

    Objective-C

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

    Swift

    var actions: [AnyHashable : Any]? { get }
  • Factory method for building banner display content with a builder block.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    builderBlock

    The builder block.

    Return Value

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

  • Extends a banner display content with a builder block.

    Declaration

    Objective-C

    - (nullable UAInAppMessageBannerDisplayContent *)extend:
        (nonnull void (^)(UAInAppMessageBannerDisplayContentBuilder *_Nonnull))
            builderBlock;

    Swift

    func extend(_ builderBlock: @escaping (InAppMessageBannerDisplayContentBuilder) -> Void) -> InAppMessageBannerDisplayContent?

    Parameters

    builderBlock

    The builder block.

    Return Value

    An extended instance of UAInAppMessageBannerDisplayContent.