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
Copied to your clipboard
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.

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)")
}
Copied to your clipboard
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)")
}

InboxState

InboxSettings

Last updated 4/6/2026

Was this helpful?

Yes

InboxSchemaData

Class Definition.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Public Properties

Usage

Class Definition