Modal Structure Reference


                    
                    
                    Template

Modal templates

Declaration

Swift

public enum Template : String, Codable, Sendable


                    
                    
                    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?


                    
                    
                    footer

The footer

Declaration

Swift

public var footer: InAppMessageButtonInfo?


                    
                    
                    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?


                    
                    
                    allowFullscreenDisplay

If the modal can be displayed as fullscreen on small devices

Declaration

Swift

public var allowFullscreenDisplay: Bool?


                    
                    
                    init(heading:body:media:footer:buttons:buttonLayoutType:template:dismissButtonColor:backgroundColor:borderRadius:allowFullscreenDisplay:)

Modal in-app message model initializer

Declaration

Swift

public init(
    heading: InAppMessageTextInfo? = nil,
    body: InAppMessageTextInfo? = nil,
    media: InAppMessageMediaInfo? = nil,
    footer: InAppMessageButtonInfo? = nil,
    buttons: [InAppMessageButtonInfo],
    buttonLayoutType: InAppMessageButtonLayoutType? = nil,
    template: Template,
    dismissButtonColor: InAppMessageColor? = nil,
    backgroundColor: InAppMessageColor? = nil,
    borderRadius: Double? = nil,
    allowFullscreenDisplay: Bool? = nil
)

Parameters

`heading`	Model defining the message heading
`body`	Model defining the message body
`media`	Model defining the message media
`footer`	Model defining a footer button
`buttons`	Message button models
`buttonLayoutType`	Layout for buttons
`template`	Layout template defining relative position of heading, body and media
`dismissButtonColor`	Dismiss button color
`backgroundColor`	Background color
`borderRadius`	Border radius of the message body
`allowFullscreenDisplay`	Flag determining if the message can be displayed as fullscreen on small devices