Skip to content

Commit 66d9138

Browse files
learn-build-service-prod[bot]learn-build-service-prod[bot]
authored
Merge pull request #5655 from MicrosoftDocs/main
Auto Publish – main to live - 2025-08-01 05:00 UTC
2 parents 619d168 + f77435c commit 66d9138

File tree

7 files changed

+67
-66
lines changed

7 files changed

+67
-66
lines changed

‎.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9129,6 +9129,11 @@
91299129
"source_path": "hub/apps/design/shell/tiles-and-notifications/toast-ux-guidance.md",
91309130
"redirect_url": "../../../develop/notifications/app-notifications/toast-ux-guidance",
91319131
"redirect_document_id": false
9132+
},
9133+
{
9134+
"source_path": "hub/apps/develop/windows-integration/microsoft-copliot-key-provider.md",
9135+
"redirect_url": "/windows/apps/develop/windows-integration/microsoft-copilot-key-provider",
9136+
"redirect_document_id": false
91329137
}
91339138
]
91349139
}

‎hub/apps/develop/platform/csharp-winrt/create-windows-runtime-component-cswinrt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Walkthrough—Create a C#/WinRT component, and consume it from C++/WinRT
2+
title: Walkthrough—Create a C#/WinRT component, and consume it from C++/WinRT
33
description: Author a Windows Runtime component with C#/WinRT, and consume it from a native application.
44
ms.date: 03/15/2022
55
ms.topic: article

‎hub/apps/develop/platform/csharp-winrt/create-winrt-component-winui-cswinrt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Walkthrough—Create a C# component with WinUI 3 controls, and consume it from a C++/WinRT app that uses the Windows App SDK
2+
title: Walkthrough—Create a C# component with WinUI 3 controls, and consume it from a C++/WinRT app that uses the Windows App SDK
33
description: Author a Windows Runtime component with C#/WinRT with WinUI controls, and consume it from any Windows App SDK app.
44
ms.date: 03/15/2022
55
ms.topic: article
@@ -184,4 +184,4 @@ Consumption from packaged apps that use a separate **Windows Application Packagi
184184

185185
- [C#/WinRT Authoring Sample app](https://github.com/microsoft/WindowsAppSDK-Samples/tree/main/Samples/CustomControls)
186186
- [Authoring C#/WinRT Components](https://github.com/microsoft/CsWinRT/blob/master/docs/authoring.md)
187-
- [Managed component hosting](https://github.com/microsoft/CsWinRT/blob/master/docs/hosting.md)
187+
- [Managed component hosting](https://github.com/microsoft/CsWinRT/blob/master/docs/hosting.md)

‎hub/apps/develop/windows-integration/copilot-key-state.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.localizationpriority: medium
1212

1313
This article describes how apps can register to be activated and receive notifications when the Microsoft Copilot hardware key or Windows key + C is pressed, pressed and held, and released. This feature enables apps to perform different actions depending on which key state change is detected. For example, an app may perform normal activation when the key is single-pressed, but take a screenshot when the key is pressed and held. Or, an app may begin recording audio and show a status indicator that audio is being recorded when the key is pressed and held, and then stop recording audio when the key is released. The key must be pressed and held for at least 300 ms to move into the held state.
1414

15-
This feature extends the features of a basic Microsoft Copilot hardware key provider, which simply registers to be launched when the hardware key is pressed. For more information, see [Microsoft Copilot hardware key providers](microsoft-copliot-key-provider.md).
15+
This feature extends the features of a basic Microsoft Copilot hardware key provider, which simply registers to be launched when the hardware key is pressed. For more information, see [Microsoft Copilot hardware key providers](microsoft-copilot-key-provider.md).
1616

1717
The rest of this article will walk through creating a simple C# WinUI 3 app that responds to activation initiated by a single press or a press and hold and release of the Microsoft Copilot button.
1818

‎hub/apps/develop/windows-integration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The following table lists the Windows system components that support integration
1717
| Feature | Description |
1818
|--|--|
1919
| [Feed providers](../feeds/feed-providers.md) | Learn how to integrate into the Windows feeds experience. |
20-
| [Microsoft Copilot hardware key providers](microsoft-copliot-key-provider.md) | Learn how to register as an app that can be selected as the launch app for the Microsoft Copilot hardware key. |
20+
| [Microsoft Copilot hardware key providers](microsoft-copilot-key-provider.md) | Learn how to register as an app that can be selected as the launch app for the Microsoft Copilot hardware key. |
2121
| [Search providers](../search/search-providers.md) | Learn how to integrate into the Windows Search experience. |
2222
| [Widget providers](../widgets/widget-providers.md) | Learn how to implement a Windows widget service provider to support your app. |
2323

‎hub/apps/develop/windows-integration/microsoft-copliot-key-provider.md renamed to ‎hub/apps/develop/windows-integration/microsoft-copilot-key-provider.md

Lines changed: 56 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,56 @@
1-
---
2-
title: Microsoft Copilot hardware key providers
3-
description: Learn how to register as an app that can be selected as the launch app for the Microsoft Copilot hardware key.
4-
ms.topic: article
5-
ms.date: 10/25/2024
6-
ms.localizationpriority: medium
7-
---
8-
9-
10-
11-
# Microsoft Copilot hardware key providers
12-
13-
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 or the Windows key + C is pressed.
14-
15-
> [!NOTE]
16-
> It is recommended that apps that register to be a Microsoft Copilot hardware key provider be implemented as single-window apps.
17-
18-
## Microsoft Copilot hardware key app extension
19-
20-
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](/windows/apps/desktop/modernize/package-identity-overview). 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](/uwp/schemas/appxpackage/uapmanifestschema/schema-root). Microsoft Copilot hardware key providers declare their registration information within the [uap3:AppExtension](/uwp/schemas/appxpackage/uapmanifestschema/element-uap3-appextension-manual). The **Name** attribute of the extension must be set to "com.microsoft.windows.copilotkeyprovider".
21-
22-
23-
```xml
24-
<Package
25-
...
26-
27-
xmlns:uap3="http://schemas.microsoft.com/appx/manifest/uap/windows10/3"
28-
...>
29-
<Applications>
30-
<Application...>
31-
...
32-
<Extensions>
33-
<uap3:Extension Category="windows.appExtension">
34-
<uap3:AppExtension Name="com.microsoft.windows.copilotkeyprovider"
35-
Id="MyAppId"
36-
DisplayName="App display name"
37-
Description="App description"
38-
PublicFolder="Public" />
39-
</uap3:Extension>
40-
</Extensions>
41-
...
42-
</Application>
43-
</Applications>
44-
...
45-
</Package>
46-
```
47-
48-
The following table *uap3:AppExtension* describes the attributes of the **uap3:AppExtension** element.
49-
50-
| Attribute | Description | Required |
51-
|-----------|-------------|----------|
52-
| Id | The app-defined identifier for the app. | Yes |
53-
| DisplayName | The app name displayed in the Windows Copilot hardware button picker UI. | Yes |
54-
| Description | The app description displayed in the Windows Copilot hardware button picker UI. | Yes |
55-
| PublicFolder| The folder that the instance declares as the location where a host can have read access to files through a broker. | Yes |
56-
57-
58-
## Sign your Windows Copilot hardware key provider
59-
60-
Provider apps must be signed in order to be enabled as a target of the Microsoft Copilot hardware key. For information on packaging and signing your app, see [Package a desktop or UWP app in Visual Studio](/windows/msix/package/packaging-uwp-apps).
1+
---
2+
title: Microsoft Copilot hardware key providers
3+
description: Learn how to register as an app that can be selected as the launch app for the Microsoft Copilot hardware key.
4+
ms.topic: article
5+
ms.date: 10/25/2024
6+
ms.localizationpriority: medium
7+
---
8+
9+
# Microsoft Copilot hardware key providers
10+
11+
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 or the Windows key + C is pressed.
12+
13+
> [!NOTE]
14+
> It is recommended that apps that register to be a Microsoft Copilot hardware key provider be implemented as single-window apps.
15+
16+
## Microsoft Copilot hardware key app extension
17+
18+
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](/windows/apps/desktop/modernize/package-identity-overview). 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](/uwp/schemas/appxpackage/uapmanifestschema/schema-root). Microsoft Copilot hardware key providers declare their registration information within the [uap3:AppExtension](/uwp/schemas/appxpackage/uapmanifestschema/element-uap3-appextension-manual). The **Name** attribute of the extension must be set to "com.microsoft.windows.copilotkeyprovider".
19+
20+
```xml
21+
<Package
22+
...
23+
24+
xmlns:uap3="http://schemas.microsoft.com/appx/manifest/uap/windows10/3"
25+
...>
26+
<Applications>
27+
<Application...>
28+
...
29+
<Extensions>
30+
<uap3:Extension Category="windows.appExtension">
31+
<uap3:AppExtension Name="com.microsoft.windows.copilotkeyprovider"
32+
Id="MyAppId"
33+
DisplayName="App display name"
34+
Description="App description"
35+
PublicFolder="Public" />
36+
</uap3:Extension>
37+
</Extensions>
38+
...
39+
</Application>
40+
</Applications>
41+
...
42+
</Package>
43+
```
44+
45+
The following table *uap3:AppExtension* describes the attributes of the **uap3:AppExtension** element.
46+
47+
| Attribute | Description | Required |
48+
|-----------|-------------|----------|
49+
| Id | The app-defined identifier for the app. | Yes |
50+
| DisplayName | The app name displayed in the Windows Copilot hardware button picker UI. | Yes |
51+
| Description | The app description displayed in the Windows Copilot hardware button picker UI. | Yes |
52+
| PublicFolder| The folder that the instance declares as the location where a host can have read access to files through a broker. | Yes |
53+
54+
## Sign your Windows Copilot hardware key provider
55+
56+
Provider apps must be signed in order to be enabled as a target of the Microsoft Copilot hardware key. For information on packaging and signing your app, see [Package a desktop or UWP app in Visual Studio](/windows/msix/package/packaging-uwp-apps).

‎hub/apps/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ items:
326326
- name: Overview
327327
href: develop/windows-integration/index.md
328328
- name: Copilot hardware key
329-
href: develop/windows-integration/microsoft-copliot-key-provider.md
329+
href: develop/windows-integration/microsoft-copilot-key-provider.md
330330
items:
331331
- name: Handle Microsoft Copilot hardware key state changes
332332
href: develop/windows-integration/copilot-key-state.md

0 commit comments

Comments
 (0)