Microsoft Copilot hardware key providers
Starting with Windows Build 22621, apps can register to be included in the picker UI that allows users to select the app that is launched when the Microsoft Copilot hardware key is pressed.
Note
It is recommended that apps that register to be a Microsoft Copilot hardware key provider be implemented as single-window apps.
Microsoft Copilot hardware key app extension
An app must be packaged in order to register as a Microsoft Copilot hardware key provider. For information on app packaging, see An overview of Package Identity in Windows app. The app package manifest file, Package.appxmanifest
, supports many different extensions and features for Windows apps. The app package manifest format is defined by a set of schemas that are documented in the Package manifest schema reference. Microsoft Copilot hardware key providers declare their registration information within the uap3:AppExtension. The Name attribute of the extension must be set to "com.microsoft.windows.copilotkeyprovider".
<Package
...
xmlns:uap3="http://schemas.microsoft.com/appx/manifest/uap/windows10/3"
...>
<Applications>
<Application...>
...
<Extensions>
<uap3:Extension Category="windows.appExtension">
<uap3:AppExtension Name="com.microsoft.windows.copilotkeyprovider"
Id="MyAppId"
DisplayName="App display name"
Description="App description"
PublicFolder="Public" />
</uap3:Extension>
</Extensions>
...
</Application>
</Applications>
...
</Package>
The following table uap3:AppExtension describes the attributes of the uap3:AppExtension element.
Attribute | Description | Required |
---|---|---|
Id | The app-defined identifier for the app. | Yes |
DisplayName | The app name displayed in the Windows Copilot hardware button picker UI. | Yes |
Description | The app description displayed in the Windows Copilot hardware button picker UI. | Yes |
PublicFolder | The folder that the instance declares as the location where a host can have read access to files through a broker. | Yes |
Windows developer