Home Screen Layout
com.apple.homescreenlayout
The payload that configures the Home Screen layout.
iOS 9.3+tvOS 11.0+
Apple schemaRequires supervision on iOS, tvOS · Only one instance per profile
Configuration Keys (2)
| Key | Type | Description | Default | Range |
|---|---|---|---|---|
Dockarray | array | 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. | Default: — | Range: — |
IconItemdict | dict | An array of dictionaries that conform to the icon dictionary format. | Default: — | Range: — |
Typestringrequired | string | The type of the Dock item. | Default: — | Range: Application, Folder, WebClip |
DisplayNamestring | string | The human-readable string shown to the user. This setting is valid only if the type is `Folder`. | Default: — | Range: — |
BundleIDstring | string | The bundle identifier of the app. The device requires this setting if the type is `Application`. | Default: — | Range: — |
Pagesarray | array | An array of arrays of dictionaries, each conforming to the icon dictionary format. This setting is valid only if the type is `Folder`. | Default: — | Range: — |
PagesItemarray | array | — | Default: — | Range: — |
IconItemdict | dict | An array of dictionaries that conform to the icon dictionary format. | Default: — | Range: — |
URLstringiOS 11.3+ | string | The URL of the existing web clip for this item. The device requires this setting 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. | Default: — | Range: — |
Pagesarrayrequired | array | An array of arrays of dictionaries, each of which must conform to the icon dictionary format. | Default: — | Range: — |
PagesItemarray | array | — | Default: — | Range: — |
IconItemdict | dict | An array of dictionaries that conform to the icon dictionary format. | Default: — | Range: — |
Typestringrequired | string | The type of the Dock item. | Default: — | Range: Application, Folder, WebClip |
DisplayNamestring | string | The human-readable string shown to the user. This setting is valid only if the type is `Folder`. | Default: — | Range: — |
BundleIDstring | string | The bundle identifier of the app. The device requires this setting if the type is `Application`. | Default: — | Range: — |
Pagesarray | array | An array of arrays of dictionaries, each conforming to the icon dictionary format. This setting is valid only if the type is `Folder`. | Default: — | Range: — |
PagesItemarray | array | — | Default: — | Range: — |
URLstringiOS 11.3+ | string | The URL of the existing web clip for this item. The device requires this setting 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. | Default: — | Range: — |