Skip to content

Commit 02f7c2b

Browse files
committed
Merged PR 22212: Checking in descriptions for UriEntity and related APIs
Checking in descriptions for UriEntity and related APIs ---- #### AI description (iteration 1) #### PR Classification Documentation update for new UriEntity APIs. #### PR Summary This PR introduces detailed API documentation for the UriActionEntity and its related creation method, while updating related references in the enumeration and other API docs. - Added `/windows.ai.actions/actionentityfactory_createurientity_492063993.md` to document the CreateUriEntity method. - Introduced `/windows.ai.actions/uriactionentity.md` and `/windows.ai.actions/uriactionentity_uri.md` for the UriActionEntity class and its Uri property. - Updated `/windows.ai.actions/actionentitykind.md` to include a new field for the Uri entity. - Enhanced return documentation in `/windows.ai.actions/actionentityfactory_createtableentity_1260648862.md`. <!-- GitOpsUserAgent=GitOps.Apps.Server.pullrequestcopilot -->
2 parents 5c0b03d + 80124b9 commit 02f7c2b

6 files changed

Lines changed: 106 additions & 1 deletion

windows.ai.actions/actionentityfactory_createtableentity_1260648862.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ The number of columns in the table. The system determines the number of rows by
2626

2727
## -returns
2828

29+
A new **TableActionEntity**.
30+
2931
## -remarks
3032

3133
## -see-also
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
-api-id: M:Windows.AI.Actions.ActionEntityFactory.CreateUriEntity(Windows.Foundation.Uri)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.AI.Actions.ActionEntityFactory.CreateUriEntity(Windows.Foundation.Uri)
7+
8+
<!--
9+
public Windows.AI.Actions.UriActionEntity CreateUriEntity (System.Uri Uri);
10+
-->
11+
12+
13+
## -description
14+
15+
Creates a new instance of [UriActionEntity](uriactionentity.md).
16+
17+
## -parameters
18+
19+
### -param Uri
20+
21+
The URI associated with the **UriActionEntity**.
22+
23+
## -returns
24+
25+
A new **UriActionEntity**.
26+
27+
## -remarks
28+
29+
## -see-also
30+
31+
## -examples
32+
33+

windows.ai.actions/actionentitykind.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,24 @@ The entity is a [RemoteFileActionEntity](remotefileactionentity.md).
4646

4747
### -field Table: 7
4848

49+
The entity is a [TableActionEntity](tableactionentity.md).
50+
4951
### -field Contact: 8
5052

53+
The entity is a [ContactActionEntity](contactactionentity.md).
54+
55+
### -field Uri: 9
56+
57+
The entity is a [UriActionEntity](uriactionentity.md).
58+
59+
### -field Array: 10
60+
61+
### -field Appointment: 11
62+
63+
### -field Date: 12
64+
65+
### -field CustomText: 13
66+
5167
## -remarks
5268

5369
This enumeration is used by the [ActionEntity.Kind](actionentity_kind.md) property.

windows.ai.actions/contactactionentity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ public sealed class ContactActionEntity : Windows.AI.Actions.ActionEntity
1212

1313
## -description
1414

15-
A subtype of [ActionEntity](actionentity.md) that represents a document.
15+
A subtype of [ActionEntity](actionentity.md) that represents a contact.
1616

1717
## -remarks
1818

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
-api-id: T:Windows.AI.Actions.UriActionEntity
3+
-api-type: winrt class
4+
---
5+
6+
# Windows.AI.Actions.UriActionEntity
7+
8+
<!--
9+
public sealed class UriActionEntity : Windows.AI.Actions.ActionEntity
10+
-->
11+
12+
13+
## -description
14+
15+
A subtype of [ActionEntity](actionentity.md) that represents a URI.
16+
17+
## -remarks
18+
19+
Create an instance of this class by calling [ActionEntityFactory.CreateUriEntity](actionentityfactory_createurientity_492063993.md).
20+
21+
Actions can use a *where* clause in their input combination declaration to specify that they are able to operate on one or more [Uri.Scheme](/dotnet/api/system.uri.scheme) values. For more information, see [Action definition JSON schema for App Actions on Windows](/windows/ai/app-actions/actions-json).
22+
23+
## -see-also
24+
25+
## -examples
26+
27+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
-api-id: P:Windows.AI.Actions.UriActionEntity.Uri
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.AI.Actions.UriActionEntity.Uri
7+
8+
<!--
9+
public System.Uri Uri { get; }
10+
-->
11+
12+
13+
## -description
14+
15+
Gets the URI associated with the **UriActionEntity**.
16+
17+
## -property-value
18+
19+
The URI associated with the **URIActionEntity**.
20+
21+
## -remarks
22+
23+
## -see-also
24+
25+
## -examples
26+
27+

0 commit comments

Comments
 (0)