Banner Structure Reference


                    
                    
                    Template

Banner layout templates

Declaration

Swift

public enum Template : String, Codable, Sendable


                    
                    
                    Placement

Banner placement

Declaration

Swift

public enum Placement : String, Codable, Sendable, Equatable


                    
                    
                    heading

The heading

Declaration

Swift

public var heading: InAppMessageTextInfo?


                    
                    
                    body

The body

Declaration

Swift

public var body: InAppMessageTextInfo?


                    
                    
                    media

The media

Declaration

Swift

public var media: InAppMessageMediaInfo?


                    
                    
                    buttons

The buttons

Declaration

Swift

public var buttons: [InAppMessageButtonInfo]?


                    
                    
                    buttonLayoutType

The button layout type

Declaration

Swift

public var buttonLayoutType: InAppMessageButtonLayoutType?


                    
                    
                    template

The template

Declaration

Swift

public var template: Template?


                    
                    
                    backgroundColor

The background color

Declaration

Swift

public var backgroundColor: InAppMessageColor?


                    
                    
                    dismissButtonColor

The dismiss button color

Declaration

Swift

public var dismissButtonColor: InAppMessageColor?


                    
                    
                    borderRadius

The border radius

Declaration

Swift

public var borderRadius: Double?


                    
                    
                    duration

How long the banner displays

Declaration

Swift

public var duration: TimeInterval?


                    
                    
                    placement

Banner placement

Declaration

Swift

public var placement: Placement?


                    
                    
                    actions

Tap actions

Declaration

Swift

public var actions: AirshipJSON?


                    
                    
                    init(heading:body:media:buttons:buttonLayoutType:template:backgroundColor:dismissButtonColor:borderRadius:duration:placement:actions:)

Banner in-app message model initializer

Declaration

Swift

public init(
    heading: InAppMessageTextInfo? = nil,
    body: InAppMessageTextInfo? = nil,
    media: InAppMessageMediaInfo? = nil,
    buttons: [InAppMessageButtonInfo]? = nil,
    buttonLayoutType: InAppMessageButtonLayoutType? = nil,
    template: Template? = nil,
    backgroundColor: InAppMessageColor? = nil, 
    dismissButtonColor: InAppMessageColor? = nil,
    borderRadius: Double? = nil,
    duration: TimeInterval? = nil,
    placement: Placement? = nil,
    actions: AirshipJSON? = nil
)

Parameters

`heading`	Model defining the message heading
`body`	Model defining the message body
`media`	Model defining the message media
`buttons`	Message button models
`buttonLayoutType`	Button layout model
`template`	Layout template defining text position relative to media
`backgroundColor`	Background color
`dismissButtonColor`	Dismiss button color
`borderRadius`	Border radius of the message body
`duration`	Duration before message is dismissed
`placement`	Placement of message on its parent
`actions`	Actions to execute on message tap