InboxSchemaData

Represents the schema data for an inbox that drives the layout, heading, empty state, and unread indicator behavior of the InboxUI.

Class Definition

public class InboxSchemaData: NSObject, Codable

Public Properties

Property
Type
Description
content
InboxSettings
The inbox configuration settings, containing layout, heading, capacity, empty state, and unread indicator configuration.

Usage

InboxSchemaData is available as the inboxSchemaData property on InboxUI. It is set automatically once the inbox loads, and is nil while in the loading state.

data-slots=heading, code
data-repeat=1
data-languages=Swift

Swift

let inboxUI = Messaging.getInboxUI(for: Surface(path: "inbox"))

// After the inbox loads, inboxSchemaData is populated
if let schemaData = inboxUI.inboxSchemaData {
    print("Layout: \(schemaData.content.layout.orientation)")
    print("Capacity: \(schemaData.content.capacity)")
}