The payload that configures the Home Screen layout.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
Dock Dock An array of dictionaries, each of which must conform to the icon dictionary format. If this key isn't present, the user's Dock is empty. 1 subkey | array | optional | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ IconItem IconItem An array of dictionaries that conform to the icon dictionary format. 5 subkeys | dictionary | — | ✓Yes | iOS (9.3+)tvOS (11.0+) | |
└─ └─ Type Type The type of the Dock item. | string | required | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ └─ DisplayName DisplayName The human-readable string shown to the user. This setting is valid only if the type is `Folder`. | string | optional | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ └─ BundleID BundleID The bundle identifier of the app. This setting is required if the type is `Application`. | string | optional | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ └─ Pages Pages An array of arrays of dictionaries, each conforming to the icon dictionary format. This setting is valid only if the type is `Folder`. 1 subkey | array | optional | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ └─ └─ PagesItem PagesItem 1 subkey | array | — | ✓Yes | iOS (9.3+)tvOS (11.0+) | |
└─ └─ └─ └─ [Structure continues recursively] ↻ This structure continues with 1 subkey (deeply nested - 1 subkey). See Apple's documentation for the complete structure. | — | ✓Yes | iOS (9.3+)tvOS (11.0+) | ||
└─ └─ URL URL The URL of the existing web clip for this item. This setting is required if `type` is `WebClip`. If more than one web clip exists with the same URL, the behavior is undefined.
Specifying a web clip in this payload doesn't create the web clip. Use the `WebClip` payload to create a web clip. | string | optional | — | ✓Yes | iOS (11.3+) |
Pages Pages An array of arrays of dictionaries, each of which must conform to the icon dictionary format. 1 subkey | array | required | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ PagesItem PagesItem 1 subkey | array | — | ✓Yes | iOS (9.3+)tvOS (11.0+) | |
└─ └─ IconItem IconItem An array of dictionaries that conform to the icon dictionary format. 5 subkeys | dictionary | — | ✓Yes | iOS (9.3+)tvOS (11.0+) | |
└─ └─ └─ Type Type The type of the Dock item. | string | required | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ └─ └─ DisplayName DisplayName The human-readable string shown to the user. This setting is valid only if the type is `Folder`. | string | optional | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ └─ └─ BundleID BundleID The bundle identifier of the app. This setting is required if the type is `Application`. | string | optional | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ └─ └─ Pages Pages An array of arrays of dictionaries, each conforming to the icon dictionary format. This setting is valid only if the type is `Folder`. 1 subkey | array | optional | — | ✓Yes | iOS (9.3+)tvOS (11.0+) |
└─ └─ └─ └─ [Structure continues recursively] ↻ This structure continues with 1 subkey (recursive structure - refers back to Pages). See Apple's documentation for the complete structure. | — | ✓Yes | iOS (9.3+)tvOS (11.0+) | ||
└─ └─ └─ URL URL The URL of the existing web clip for this item. This setting is required if `type` is `WebClip`. If more than one web clip exists with the same URL, the behavior is undefined.
Specifying a web clip in this payload doesn't create the web clip. Use the `WebClip` payload to create a web clip. | string | optional | — | ✓Yes | iOS (11.3+) |
