Home Screen Layout ¶

Template

The Home Screen Layout Payload defines a layout of apps, folders, and web clips for the Home screen. It is supported on the User Channel.

Note

If a home screen layout puts more than six items in the iPad dock the location of the seventh and succeeding items may be undefined but they will not be omitted.

Warning

Take note that Pages is an array of array of dictionaries. Each item in the array is a home screen.

Contents

Home Screen Layout
- Summary
- Keys
  - Icon Dictionary
    - Type

Summary ¶

Supervised Only:
PayloadType:	com.apple.homescreenlayout
	N/A
macOS:	N/A
macOS Deprecated:
	N/A
iOS:	9.3
iOS Deprecated:	N/A
Highlander:	N/A

Keys ¶

Icon Dictionary ¶

Name	Type	Title	Description	Required
Type	string	Item Type	Type of the item to add	always
DisplayName	string	Display Name	Human-readable string to be shown to the user.	n/a
BundleID	string	Bundle ID	Required if App type. The bundle identifier of the app.	n/a
Pages	array	Home Screen Pages Items	Optional. An array of dictionaries, each of which must conform to the icon dictionary format.	n/a
URL	string	WebClip URL	Required if WebClip type. URL of the WebClip being referenced. If more than one WebClip exists with the same URL, the behavior is undefined.	n/a

Type ¶

Item Type

Type of the item to add

Type	Default	Required	Regex	iOS	macOS	Supervised
string	N/A	always	N/A	N/A	N/A	N/A

Valid Choices¶

Application
Folder

Home Screen Layout¶

Summary¶

Keys¶

Icon Dictionary¶

Type¶