Skip to content

Commit f5dc3a9

Browse files
authored
Update settings-common.md
Update missing structure Moved sections around to match bond Fixed a missing 'dark' Improved description for icon
1 parent c30eb07 commit f5dc3a9

File tree

1 file changed

+25
-50
lines changed

1 file changed

+25
-50
lines changed

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

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

117-
## AppList
117+
## AppList Backup Data
118118

119119
### Type: Windows.Data.Apps.AppMetaData structure
120120

@@ -125,7 +125,7 @@ The value of the *compatFlags* field of the backup JSON file is a combination of
125125
| appId | wstring | PackageFamilyName (packaged) or ProductCode (unpackaged). |
126126
| installSource | wstring | Description of type of installer for the app. See *installSource* for supported values. |
127127
| lightIconInfo | **IconInfo** | Information about the light icon. |
128-
| darkIconInfo | **IconInfo** | Information about the light icon. |
128+
| darkIconInfo | **IconInfo** | Information about the dark icon. |
129129
| appName | wstring | App display name. |
130130
| publisher | wstring | Publishers name of the app from Add Remove Programs. |
131131
| lastLaunchTime | uint64 | This is a calculated value that represents the last time the app was launched. |
@@ -166,9 +166,18 @@ Supported values for the *wingetSource* field.
166166

167167
| Name | Type | Description |
168168
|------|-------|---------|
169-
| appIconAssetId | wstring | The ID representing an icon. |
169+
| appIconAssetId | wstring | The ID representing an icon from the cloud. The appIconAssetId represents the icon stored in the cloud which was generated from the app installer either through add remove programs metadata or AppxManifest files. |
170170
| isPlated | bool | Plated or not. |
171171

172+
### Type: Windows.Data.Apps.ShortcutInfo structure
173+
174+
#### ShortcutInfo values
175+
176+
| Name | Type | Description |
177+
|------|-------|---------|
178+
| targetPath | wstring | Link to the executable that launching the tile will shell execute. |
179+
| shortcutArgs | wstring | Arguments provided on launch. |
180+
172181
### Type: Windows.Data.Apps.AppLevelTileInfo structure
173182

174183
#### AppLevelTileInfo values
@@ -184,17 +193,6 @@ Supported values for the *wingetSource* field.
184193
| shortcut | **ShortcutInfo** | Shortcut information. |
185194
| suiteName | wstring | String name for a collection of apps. |
186195

187-
### Type: Windows.Data.Apps.ShortcutInfo structure
188-
189-
#### ShortcutInfo values
190-
191-
| Name | Type | Description |
192-
|------|-------|---------|
193-
| targetPath | wstring | Link to the executable that launching the tile will shell execute. |
194-
| shortcutArgs | wstring | Arguments provided on launch. |
195-
196-
### Type: Windows.Data.Apps.FileInfo structure
197-
198196
#### FileInfo values
199197

200198
FileInfo values are populated from the *App Compatibility* JSON above. All FileInfo values are provided as WSTRINGs, though some of the values in the JSON are different.
@@ -247,6 +245,19 @@ FileInfo values are populated from the *App Compatibility* JSON above. All FileI
247245
| sha256 | wstring | Read from App compatibility JSON. Optional.|
248246
| 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)|
249247

248+
### Type: Windows.Data.Apps.AppCompatInfo structure
249+
250+
#### AppCompatInfo values
251+
| Name | Type | Description |
252+
|------|-------|---------|
253+
| name | wstring | Read from App compatibility JSON. |
254+
| path | wstring | Read from App compatibility JSON. |
255+
| appId | wstring | Read from App compatibility JSON.|
256+
| programId | wstring | Read from App compatibility JSON.|
257+
| compatFlags | wstring | Read from App compatibility JSON. |
258+
| restoreActions | wstring | Read from App compatibility JSON|
259+
| files | **vector <FileInfo>** | Read from App compatibility JSON.|
260+
250261
### Type: Windows.Data.Apps.DeviceMetadata structure
251262

252263
#### DeviceMetadata values
@@ -270,42 +281,6 @@ Supported *userIntent* values.
270281
| 0b01000000 | Business |
271282
| 0b10000000 | Development |
272283

273-
## AppList - Tiles
274-
275-
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.
276-
277-
The following code segment describes the format of the file and provides descriptions for each field.
278-
279-
```json
280-
{
281-
    "tileId": Unique tile identifier,
282-
    "displayName": String displayed on tile,
283-
    "sortName": String value used for sorting in search,
284-
    "packageId": String containing the package name the executable is associated with,
285-
    "shortcut": {
286-
        "Data": {
287-
            "targetPath": String containing the path to the executable that launching the tile will shell execute,
288-
            "shortcutArgs": A string containing the arguments provided on launch
289-
      }
290-
    },
291-
    "suiteName": ""
292-
}
293-
294-
lightIconInfo=>{
295-
    "Data": {
296-
        "appIconAssetId": Unique identifier for light icon,
297-
        "isPlated": Plated or not.    }
298-
}
299-
300-
darkIconInfo=>{
301-
    "Data": {
302-
        "appIconAssetId": Unique identifier for dark icon,
303-
        "isPlated": Plated or not.
304-
    }
305-
}
306-
307-
```
308-
309284
## Autoplay
310285

311286
This setting helps to set defaults for removable drives and memory cards

0 commit comments

Comments
 (0)