Skip to content

Commit 018a3b1

Browse files
committed
Checking in new settings backup information
1 parent 1d940dd commit 018a3b1

File tree

1 file changed

+238
-0
lines changed

1 file changed

+238
-0
lines changed

hub/apps/develop/settings/settings-common.md

Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,240 @@ The value of the *compatFlags* field of the backup JSON file is a combination of
113113
| 0x00004000 | Generic hardware incompatibility. |
114114
| 0x00008000 | App is incompatible up to certain version. |
115115

116+
## AppList
117+
118+
As part of backup, when the user has enabled backup of the apps list, the following data is collected and placed in a db file for uploading to the Cloud. The path to this JSON is:
119+
120+
`%LocalAppData%\ConnectedDevicesPlatform\<Any folder starting with “AAD.”>\Activity.db`
121+
122+
> [!NOTE]
123+
> This data is ephemeral and is removed locally once it has been uploaded to the cloud.
124+
125+
The following code segment describes the format of the file and provides descriptions for each field.
126+
127+
```json
128+
{
129+
    "appId": Unique identifier for App ,
130+
    "installSource": Description of type of installer for the app. See below for supported values,
131+
    "appName": String containing the friendly name of the app from ARP [TBD - What is ARP?],
132+
    "publisher": String containing the publisher name of the app from ARP [TBD - What is ARP?],
133+
    "lastLaunchTime": Calculated value. The last time the app was launched. ,
134+
    "appVersion": Version of the app from ARP,
135+
    "appLanguage": Language list in ARP,
136+
    "appArch": Architecture specified in ARP,
137+
    "reinstallId": Reinstall ID specified in ARP,
138+
    "productUrl": Product URL Specified in ARP,
139+
    "isPinned": A boolean indicating if this app was pinned to the start menu ,
140+
    "wingetID": Identifier to indicate if this app can be installed through winget,
141+
    "wingetSource": Specifies if this app was installed originally from winget community repository, or from the web. See below for supported values.
142+
}
143+
lightIconInfo=>{
144+
    "Data": {
145+
        "appIconAssetId": Unique identifier for light icon,
146+
        "isPlated": false
147+
    }
148+
}
149+
150+
darkIconInfo=>{
151+
    "Data": {
152+
        "appIconAssetId": Unique identifier for light icon,
153+
        "isPlated": false
154+
    }
155+
}
156+
157+
```
158+
159+
Supported values for the *installSource* field.
160+
161+
| Value | Description |
162+
|-------|-------------|
163+
| "Store MSIX" | An MSIX from the Microsoft Store |
164+
| "Sideloaded MSIX” | A sideloaded MSIX |
165+
| "Edge PWA MSIX” | A PWA MSIX |
166+
| "Unknown MSIX” | Not one of the other MSIX values. |
167+
| “Store Win32” | A non-UWP app from the Microsoft Store |
168+
| "Android" | An Android app |
169+
| "External MSI" | An external MSI. |
170+
171+
Supported values for the *wingetSource* field.
172+
| Value | Description |
173+
|-------|-------------|
174+
| "External" | From the web, but winget has an ID. |
175+
| "Winget" | From the winget catalog. |
176+
| "Spark" | Spark app. |
177+
| "MSStore" | Microsoft Store. |
178+
| "NoReliableInfo" | Don’t have info from winget APIs. |
179+
180+
### Type: Windows.Data.Apps.IconInfo structure
181+
182+
#### IconInfo values
183+
184+
| Name | Type | Description |
185+
|------|-------|---------|
186+
| appIconAssetId | wstring | The ID representing an icon. |
187+
| isPlated | bool | Plated or not. |
188+
189+
### Type: Windows.Data.Apps.AppMetaData structure
190+
191+
#### AppMetaData values
192+
193+
| Name | Type | Description |
194+
|------|-------|---------|
195+
| appId | wstring | PackageFamilyName (packaged) or ProductCode (unpackaged) |
196+
| installSource | bool | Description of type of installer for the app. See above for supported values |
197+
| lightIconInfo | **IconInfo** | Information about the light icon. |
198+
| darkIconInfo | **IconInfo** | Information about the light icon. |
199+
| appName | wstring | App display name. |
200+
| publisher | wstring | Publishers name of the app from ARP. |
201+
| lastLaunchTime | uint64 | Calculated value. The last time the app was launched. |
202+
| appVersion | wstring | Version of the app from ARP. |
203+
| appLanguage | wstring | Language list in ARP. |
204+
| appArch | wstring | Architecture specified in ARP. |
205+
| reinstallId | wstring | Reinstall ID specified in ARP. |
206+
| productUrl | wstring | Product URL Specified in ARP. |
207+
| productUrl | wstring | Product URL Specified in ARP. |
208+
| isPinned | bool | Boolean indicating if this app was pinned to the start menu. |
209+
| wingetID | wstring | Identifier to indicate if this app can be installed through winget. |
210+
| wingetSource | wstring | Specifies if this app was installed originally from winget community repository, or from the web. See above for supported values. |
211+
212+
213+
### Type: Windows.Data.Apps.ShortcutInfo structure
214+
struct
215+
216+
#### ShortcutInfo values
217+
218+
| Name | Type | Description |
219+
|------|-------|---------|
220+
| targetPath | wstring | Link to the executable that launching the tile will shell execute. |
221+
| shortcutArgs | wstring | Arguments provided on launch. |
222+
223+
### Type: Windows.Data.Apps.AppLevelTileInfo structure
224+
225+
#### AppLevelTileInfo values
226+
227+
| Name | Type | Description |
228+
|------|-------|---------|
229+
| tileId | wstring | UnifiedTileIdentifier for tile |
230+
| lightIconInfo | **IconInfo** | UnifiedTileIdentifier for light tile |
231+
| darkIconInfo | **IconInfo** | UnifiedTileIdentifier for dark tile |
232+
| displayName | wstring | String displayed on tile |
233+
| sortName | wstring | String value used for sorting in search |
234+
| packageId | wstring | PackageFamilyName (packaged), ProductCode (unpackaged), empty for unmapped products (appId is specified in **AppMetaData**) |
235+
| shortcut | **ShortcutInfo** | Shortcut information. |
236+
| suiteName | wstring | String name for a collection of apps. |
237+
238+
### Type: Windows.Data.Apps.FileInfo structure
239+
240+
#### FileInfo values
241+
242+
| Name | Type | Description |
243+
|------|-------|---------|
244+
| name | wstring | File name. Optional. |
245+
| path | wstring | File path. Optional. |
246+
| osComponent | bool | Boolean stating if the file is an OS file. TBD - Type is wstring, but description says bool |
247+
| size | uin32 | The file size as a 32-bit value. |
248+
| magic | wstring | The PE header's magic number. Optional. TBD - What is PE?|
249+
| peHeaderHash | wstring | Hash of the file's PE header. Optional. |
250+
| sizeOfImage | wstring | PE header's SizeOfImage value. Optional. TBD - size, but type is wstring |
251+
| peChecksum | wstring | PE header's CheckSum value. Optional. |
252+
| linkDate | wstring | PE header's TimeDateStamp value. Optional. |
253+
| linkerVersion | wstring | PE header's MarjorImageVersion and MinorImageVersion. Optional. |
254+
| binFileVersion | wstring | File version obtained from GetFileVersionInfo. Optional. |
255+
| binProductVersion | wstring | Product version obtained from GetFileVersionInfo. Optional. |
256+
| binaryType | wstring | PType of binary (e.g. PE64_AMD64). Optional. |
257+
| created | wstring | File creation time obtained from file system. Optional. |
258+
| modified | wstring | File modification time obtained from file system. Optional. |
259+
| lastAccessed | wstring | File access time obtained from file system. Optional. |
260+
| verLanguage | wstring | Language obtained from **GetFileVersionInfo**. Optional.|
261+
| id | wstring | Unique identifier obtained from hashing file contents. Optional.|
262+
| switchBackContext | wstring | Value for OS runtime compatibility fixes. Optional.|
263+
| sigDisplayName | wstring | Display name obtained from the file signature. Optional.|
264+
| sigPublisherName | wstring | Publisher name obtained from the file signature. Optional.|
265+
| sigMoreInfoURL | wstring | URL obtained from the file signature. Optional.|
266+
| fileVersion | wstring | File version obtained from **GetFileVersionInfo**. Optional.|
267+
| companyName | wstring | Company name obtained from **GetFileVersionInfo**. Optional.|
268+
| fileDescription | wstring | File description obtained from **GetFileVersionInfo**. Optional.|
269+
| internalName | wstring | Internal name obtained from **GetFileVersionInfo**. Optional.|
270+
| legalCopyright | wstring | Copyright information obtained from **GetFileVersionInfo**. Optional.|
271+
| originalFileName | wstring | Original filename obtained from **GetFileVersionInfo**. Optional.|
272+
| productName | wstring | Product name obtained from **GetFileVersionInfo**. Optional.|
273+
| productVersion | wstring | Product version obtained from **GetFileVersionInfo**. Optional.|
274+
| peImageType | wstring | Image type obtained from PE header. Optional.|
275+
| peSubsystem | wstring | Subsystem obtained from PE header. Optional.|
276+
| runLevel | wstring | Executable's runlevel obtained from app manifest. Optional.|
277+
| uiAccess | wstring | UI access obtained from app manifest. Optional.|
278+
| crcChecksum | wstring | File's CRC checksum. Optional.|
279+
| clrVersion | wstring | CLR version obtained from app manifest. Optional.|
280+
| boeProgramId | wstring | Unique ID describing the application. Optional.|
281+
| boeProgramName | wstring |Same as "productName", if it exists. Otherwise same as "name". Optional.|
282+
| boeProgramPublisher | wstring |Same as "companyName", if it exists. Otherwise same as "fileDescription", if it exists. Optional.|
283+
| boeProgramVersion | wstring | USame as "productVersion", if it exists. Otherwise same as "fileVersion", if it exists. Otherwise same as "binProductVersion", if it exists. Otherwise same as "binFileVersion", if it exists . Optional.|
284+
| boeProgramLanguage | wstring | Same as "verLanguage", if it exists. Optional.|
285+
| fileSize | uint64 | File's size as a 64-bit number. Optional.|
286+
| peCharacteristics | wstring | Image characteristics obtained from PE header. Optional.|
287+
| sha256 | wstring | SHA256 hash of file. Optional.|
288+
| aumid | wstring | Application user model ID. Optional. For more information, see [Find the Application User Model ID of an installed app](/windows/configuration/store/find-aumid?tabs=ps)|
289+
290+
### Type: Windows.Data.Apps.DeviceMetadata structure
291+
292+
#### DeviceMetadata values
293+
294+
| Name | Type | Description |
295+
|------|-------|---------|
296+
| userIntent | uint32 | Present when the user identified as a developer during the Out of Box Experience (OOBE) An OR'd combination of values specifying user intent. TBD - Only two values listed in the doc. Probably need to list all of the values? |
297+
| predictedUserIntent | uint32 | Windows sets flag to indicate that the user had one or more apps that are a signal of a developer. |
298+
| devModeEnabled | bool | Whether the user has specified DevMode. |
299+
300+
Supported *userIntent* values.
301+
302+
| Value | Description |
303+
|-------|-------------|
304+
| 0x00000001 | INTENT_BUSINESS |
305+
| 0x00000001 | INTENT_GAMING |
306+
307+
308+
309+
## AppList - Tiles
310+
311+
As part of backup, when the user has enabled backup of the apps list, the following data about tiles is collected and placed in a db file for uploading to the Cloud. The path to this JSON is:
312+
313+
`%LocalAppData%\ConnectedDevicesPlatform\<Any folder starting with “AAD.”>\Activity.db`
314+
315+
> [!NOTE]
316+
> This data is ephemeral and is removed locally once it has been uploaded to the cloud.
317+
318+
The following code segment describes the format of the file and provides descriptions for each field.
319+
320+
```json
321+
{
322+
    "tileId": Unique tile identifier,
323+
    "displayName": String displayed on tile,
324+
    "sortName": String value used for sorting in search,
325+
    "packageId": String containing the package name the executable is associated with,
326+
    "shortcut": {
327+
        "Data": {
328+
            "targetPath": String containing the path to the executable that launching the tile will shell execute,
329+
            "shortcutArgs": A string containing the arguments provided on launch
330+
      }
331+
    },
332+
    "suiteName": ""
333+
}
334+
335+
lightIconInfo=>{
336+
    "Data": {
337+
        "appIconAssetId": Unique identifier for light icon,
338+
        "isPlated": TBD
339+
    }
340+
}
341+
342+
darkIconInfo=>{
343+
    "Data": {
344+
        "appIconAssetId": Unique identifier for dark icon,
345+
        "isPlated": TBD
346+
    }
347+
}
348+
349+
```
116350

117351
## Autoplay
118352

@@ -1019,6 +1253,8 @@ Specifies the set of apps pinned to the taskbar from another device.
10191253
| FavoritesMigration | REG_BLOB | A binary blob. | This is an opaque binary blob copied from the following location on the backed up. |
10201254
| Favorites | REG_SZ | 0 1 | The format of this key is undocumented. |
10211255
1256+
1257+
10221258
## Secondary accounts
10231259
10241260
Provides information about Microsoft accounts (MSA) and work or school accounts added to the device to sign in to apps or online services, in addition to the account used to log on to the device. On Windows 11, backup and restore of this setting is supported. On Windows 10, backup is supported but restore is not.
@@ -1061,6 +1297,8 @@ The user's custom spelling dictionary is stored in a file in the following file
10611297
10621298
`%userprofile%\AppData\Roaming\Microsoft\Spelling\neutral\default.dic`
10631299
1300+
1301+
10641302
## USB
10651303
10661304
This setting controls toggles such as connection notifications, battery saver and other notifications related to charging of PC.

0 commit comments

Comments
 (0)