The declaration to configure background tasks.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
Task Type TaskType The unique identifier of the set of background tasks managed with this configuration. This should be a reverse DNS style identifier. The system uses this identifier to differentiate between tasks in different configurations. | string | required | — | ✓Yes | macOS (15.0+) |
Task Description TaskDescription A description of the set of background tasks managed by this configuration. | string | optional | — | ✓Yes | macOS (15.0+) |
Executable Asset Reference ExecutableAssetReference Specifies the identifier of an asset declaration containing a reference to the files to be used for the background task configuration. The corresponding asset must be of type `com.apple.asset.data`.
The referenced data must be a zip archive of an entire directory, that will be expanded and stored in a well known location for the background task. The asset's "ContentType" and "Hash-SHA-256" keys in the "Reference" key are required.
This file should contain background task executables, scripts, and configuration files, but not the `launchd` configuration files. | string | optional | — | ✓Yes | macOS (15.0+) |
Launchd Configurations LaunchdConfigurations An array of `launchd` configuration files used to run the background tasks. 1 subkey | array | optional | — | ✓Yes | macOS (15.0+) |
└─ launchd-item launchd-item A dictionary of launchd configurations. 2 subkeys | dictionary | required | — | ✓Yes | macOS (15.0+) |
└─ └─ File Asset Reference FileAssetReference Specifies the identifier of an asset declaration containing a reference to the launchd configuration file for the background task. The referenced data must be a property list file conforming to the launchd.plist format. The asset's "ContentType" and "Hash-SHA-256" keys in the "Reference" key are required. | string | required | — | ✓Yes | macOS (15.0+) |
└─ └─ Launchd Context Context Indicates whether the launchd configuration file is applied to the system daemon, or system agent domain. | string | required | — | ✓Yes | macOS (15.0+) |
