Skip to content

Commit 8eaff5d

Browse files
drewbatgitdrewbatgit
committed
Checking in changes Kevin Larkin made offline
1 parent 7e53cb2 commit 8eaff5d

File tree

1 file changed

+60
-54
lines changed

1 file changed

+60
-54
lines changed

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

Lines changed: 60 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Settings status is accessed in one of two ways:
1616
1. Via the Windows registry: For settings below that include registry details, please use that information to access the settings.
1717
1. Via the Cloud Data Store Reader tool. These settings must be extracted from a data store to be readable. If the setting below does not list registry details, then the settings must be extracted using the Cloud Data Store Reader tool. For information on how to use this tool, see [Cloud Data Store Settings Reader Tool (readCloudDataSettings.exe)](readclouddatasettings-exe.md).
1818

19-
## App Compatability
19+
## App Compatibility
2020

2121
The app compatibility setting is a JSON file that describes compatibility information for apps installed on the device. The path to this JSON is:
2222

@@ -115,71 +115,60 @@ The value of the *compatFlags* field of the backup JSON file is a combination of
115115

116116
## AppList
117117

118-
119-
### Type: Windows.Data.Apps.IconInfo structure
120-
121-
#### IconInfo values
122-
123-
| Name | Type | Description |
124-
|------|-------|---------|
125-
| appIconAssetId | wstring | The ID representing an icon. |
126-
| isPlated | bool | Plated or not. |
127-
128118
### Type: Windows.Data.Apps.AppMetaData structure
129119

130120
#### AppMetaData values
131121

132122
| Name | Type | Description |
133123
|------|-------|---------|
134-
| appId | wstring | PackageFamilyName (packaged) or ProductCode (unpackaged) |
135-
| installSource | bool | Description of type of installer for the app. See above for supported values |
124+
| appId | wstring | PackageFamilyName (packaged) or ProductCode (unpackaged). |
125+
| installSource | wstring | Description of type of installer for the app. See *installSource* for supported values. |
136126
| lightIconInfo | **IconInfo** | Information about the light icon. |
137127
| darkIconInfo | **IconInfo** | Information about the light icon. |
138128
| appName | wstring | App display name. |
139-
| publisher | wstring | Publishers name of the app from ARP. |
140-
| lastLaunchTime | uint64 | Calculated value. The last time the app was launched. |
141-
| appVersion | wstring | Version of the app from ARP. |
142-
| appLanguage | wstring | Language list in ARP. |
143-
| appArch | wstring | Architecture specified in ARP. |
144-
| reinstallId | wstring | Reinstall ID specified in ARP. |
145-
| productUrl | wstring | Product URL Specified in ARP. |
146-
| productUrl | wstring | Product URL Specified in ARP. |
129+
| publisher | wstring | Publishers name of the app from Add Remove Programs. |
130+
| lastLaunchTime | uint64 | This is a calculated value that represents the last time the app was launched. |
131+
| appVersion | wstring | Version of the app from Add Remove Programs. |
132+
| appLanguage | wstring | Language list in Add Remove Programs. |
133+
| appArch | wstring | Architecture specified in Add Remove Programs. |
134+
| reinstallId | wstring | Reinstall ID specified in Add Remove Programs. |
135+
| productUrl | wstring | Product URL Specified in Add Remove Programs. |
147136
| isPinned | bool | Boolean indicating if this app was pinned to the start menu. |
148-
| wingetID | wstring | Identifier to indicate if this app can be installed through winget. |
149-
| wingetSource | wstring | Specifies if this app was installed originally from winget community repository, or from the web. See below for supported values. |
137+
| wingetID | wstring | Identifier to indicate if this app can be installed through winget, and the winget ID. |
138+
| wingetSource | wstring | Specifies where the app was sourced from through the Winget APIs. See *wingetSource* for supported values. |
150139

151140

152141
Supported values for the *installSource* field.
153142

154143
| Value | Description |
155144
|-------|-------------|
156-
| "Store MSIX" | An MSIX from the Microsoft Store |
157-
| "Sideloaded MSIX” | A sideloaded MSIX |
158-
| "Edge PWA MSIX” | A PWA MSIX |
159-
| "Unknown MSIX” | Not one of the other MSIX values. |
160-
| “Store Win32” | A non-UWP app from the Microsoft Store |
161-
| "Android" | An Android app |
145+
| "Store MSIX" | An MSIX from the Microsoft Store. |
146+
| "Sideloaded MSIX" | A sideloaded MSIX. |
147+
| "Edge PWA MSIX" | A PWA MSIX. |
148+
| "Unknown MSIX" | Not one of the other MSIX values. |
149+
| "Store Win32" | A non-UWP app from the Microsoft Store. |
150+
| "Android" | An Android app. |
162151
| "External MSI" | An external MSI. |
163152

164153
Supported values for the *wingetSource* field.
165154

166155
| Value | Description |
167156
|-------|-------------|
168-
| "External" | From the web, but winget has an ID. |
169-
| "Winget" | From the winget catalog. |
170-
| "Spark" | Spark app. |
171-
| "MSStore" | Microsoft Store. |
172-
| "NoReliableInfo" | Don’t have info from winget APIs. |
157+
| "External" | Installed from the web, but winget has an ID a match in the winget catalog. |
158+
| "Winget" | Installed from the winget catalog. |
159+
| "Spark" | Microsoft Store non-UWP app. |
160+
| "MSStore" | Microsoft Store MSIX app. |
161+
| "NoReliableInfo" | No data provided for source. |
173162

174-
### Type: Windows.Data.Apps.ShortcutInfo structure
175-
176163

177-
#### ShortcutInfo values
164+
### Type: Windows.Data.Apps.IconInfo structure
165+
166+
#### IconInfo values
178167

179168
| Name | Type | Description |
180169
|------|-------|---------|
181-
| targetPath | wstring | Link to the executable that launching the tile will shell execute. |
182-
| shortcutArgs | wstring | Arguments provided on launch. |
170+
| appIconAssetId | wstring | The ID representing an icon. |
171+
| isPlated | bool | Plated or not. |
183172

184173
### Type: Windows.Data.Apps.AppLevelTileInfo structure
185174

@@ -196,19 +185,30 @@ Supported values for the *wingetSource* field.
196185
| shortcut | **ShortcutInfo** | Shortcut information. |
197186
| suiteName | wstring | String name for a collection of apps. |
198187

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

201200
#### FileInfo values
201+
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.
202202

203203
| Name | Type | Description |
204204
|------|-------|---------|
205205
| name | wstring | File name. Optional. |
206206
| path | wstring | File path. Optional. |
207-
| osComponent | bool | Boolean stating if the file is an OS file. TBD - Type is wstring, but description says bool |
208-
| size | uin32 | The file size as a 32-bit value. |
209-
| magic | wstring | The PE header's magic number. Optional. TBD - What is PE?|
207+
| osComponent | wstring | Boolean stating if the file is an OS file. |
208+
| size | wstring | The file size as a 32-bit value. |
209+
| magic | wstring | The PE header's magic number. Optional. For information on the PE header, see https://learn.microsoft.com/en-us/windows/win32/debug/pe-format. |
210210
| peHeaderHash | wstring | Hash of the file's PE header. Optional. |
211-
| sizeOfImage | wstring | PE header's SizeOfImage value. Optional. TBD - size, but type is wstring |
211+
| sizeOfImage | wstring | PE header's SizeOfImage value. Optional. |
212212
| peChecksum | wstring | PE header's CheckSum value. Optional. |
213213
| linkDate | wstring | PE header's TimeDateStamp value. Optional. |
214214
| linkerVersion | wstring | PE header's MarjorImageVersion and MinorImageVersion. Optional. |
@@ -252,9 +252,10 @@ Supported values for the *wingetSource* field.
252252

253253
#### DeviceMetadata values
254254

255+
BUGBUG
255256
| Name | Type | Description |
256257
|------|-------|---------|
257-
| 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? |
258+
| userIntent | uint32 | An OR'd combination of values specifying user intent during Windows OOBE setup. See *userIntent* values.
258259
| predictedUserIntent | uint32 | Windows sets flag to indicate that the user had one or more apps that are a signal of a developer. |
259260
| devModeEnabled | bool | Whether the user has specified DevMode. |
260261

@@ -263,18 +264,24 @@ Supported *userIntent* values.
263264
| Value | Description |
264265
|-------|-------------|
265266
| 0x00000001 | INTENT_BUSINESS |
266-
| 0x00000001 | INTENT_GAMING |
267+
| 0x00000020 | INTENT_GAMING |
267268

269+
BUGBUG
270+
static const PCWSTR Option_business = L"business";
271+
static const PCWSTR Option_creativity = L"creative";
272+
static const PCWSTR Option_entertainment = L"entertainment";
273+
static const PCWSTR Option_gaming = L"gaming";
274+
static const PCWSTR Option_family = L"family";
275+
static const PCWSTR Option_schoolwork = L"schoolwork";
268276

277+
// OOBE/GetStarted/Setting all show "Development" to the User, but SDX code writes in the Registry as "developer",
278+
// so we need to match the Registry here
279+
static const PCWSTR Option_development = L"developer";
269280

270-
## AppList - Tiles
271-
272-
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:
273281

274-
`%LocalAppData%\ConnectedDevicesPlatform\<Any folder starting with “AAD.”>\Activity.db`
282+
## AppList - Tiles
275283

276-
> [!NOTE]
277-
> This data is ephemeral and is removed locally once it has been uploaded to the cloud.
284+
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.
278285

279286
The following code segment describes the format of the file and provides descriptions for each field.
280287

@@ -296,14 +303,13 @@ The following code segment describes the format of the file and provides descrip
296303
lightIconInfo=>{
297304
    "Data": {
298305
        "appIconAssetId": Unique identifier for light icon,
299-
        "isPlated": TBD
300-
    }
306+
        "isPlated": Plated or not.    }
301307
}
302308

303309
darkIconInfo=>{
304310
    "Data": {
305311
        "appIconAssetId": Unique identifier for dark icon,
306-
        "isPlated": TBD
312+
        "isPlated": Plated or not.
307313
    }
308314
}
309315

0 commit comments

Comments
 (0)