Skip to content

Commit c6e13e8

Browse files
committed
Initial pass at API reference for APIs that are stable in the 5D-early PSDK release.
1 parent f7c2f83 commit c6e13e8

40 files changed

Lines changed: 270 additions & 7 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
-api-id: T:Windows.AI.Actions.Provider.IActionFeedbackHandler
3+
-api-type: winrt interface
4+
---
5+
6+
# Windows.AI.Actions.Provider.IActionFeedbackHandler
7+
8+
<!--
9+
public interface IActionFeedbackHandler
10+
-->
11+
12+
13+
## -description
14+
15+
The interface implemented by an App Actions on Windows provider app to receive an event when the app action feedback is submitted by the user.
16+
17+
## -remarks
18+
19+
## -see-also
20+
21+
## -examples
22+
23+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
-api-id: M:Windows.AI.Actions.Provider.IActionFeedbackHandler.ProcessFeedbackAsync(Windows.AI.Actions.ActionInvocationContext,Windows.AI.Actions.ActionFeedback)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.AI.Actions.Provider.IActionFeedbackHandler.ProcessFeedbackAsync(Windows.AI.Actions.ActionInvocationContext,Windows.AI.Actions.ActionFeedback)
7+
8+
<!--
9+
public Windows.Foundation.IAsyncAction ProcessFeedbackAsync (Windows.AI.Actions.ActionInvocationContext context, Windows.AI.Actions.ActionFeedback feedback);
10+
-->
11+
12+
13+
## -description
14+
15+
Raised when user feedback is submitted for an app action.
16+
17+
## -parameters
18+
19+
### -param context
20+
21+
An [ActionInvocationContext](../windows.ai.actions/actioninvocationcontext.md) object that is used to access contextual information about the action for which feedback was submitted.
22+
23+
### -param feedback
24+
25+
A value from the [ActionFeedback](../windows.ai.actions/actionfeedback.md) enumeration specifying the type of feedback that was submitted.
26+
27+
## -returns
28+
29+
## -remarks
30+
31+
## -see-also
32+
33+
## -examples
34+
35+
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
-api-id: T:Windows.AI.Actions.Provider.IActionProvider
3+
-api-type: winrt interface
4+
---
5+
6+
# Windows.AI.Actions.Provider.IActionProvider
7+
8+
<!--
9+
public interface IActionProvider
10+
-->
11+
12+
13+
## -description
14+
15+
The interface implemented by an App Actions on Windows provider app to receive an event when the app action is invoked.
16+
17+
## -remarks
18+
19+
For information on implementing an App Actions on Windows provider app using **IActionProvider**, see [Use COM activation with App Actions for Windows
20+
](/windows/ai/app-actions/actions-com-activation).
21+
22+
## -see-also
23+
24+
## -examples
25+
26+
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.Provider.IActionProvider.InvokeAsync(Windows.AI.Actions.ActionInvocationContext)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.AI.Actions.Provider.IActionProvider.InvokeAsync(Windows.AI.Actions.ActionInvocationContext)
7+
8+
<!--
9+
public Windows.Foundation.IAsyncAction InvokeAsync (Windows.AI.Actions.ActionInvocationContext context);
10+
-->
11+
12+
13+
## -description
14+
15+
Raised when an app action has been invoked.
16+
17+
## -parameters
18+
19+
### -param context
20+
21+
An [ActionInvocationContext](../windows.ai.actions/actioninvocationcontext.md) object that is used to access contextual information about the action that was invoked, such as the action's ID, input entities, and output entities.
22+
23+
## -returns
24+
25+
An asynchronous action.
26+
27+
## -remarks
28+
29+
## -see-also
30+
31+
## -examples
32+
33+
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
-api-id: N:Windows.AI.Actions.Provider
3+
-api-type: winrt namespace
4+
---
5+
6+
# Windows.AI.Actions.Provider
7+
8+
9+
10+
## -description
11+
12+
Provides APIs for implementing an App Actions on Windows provider app.
13+
14+
## -remarks
15+
16+
For information on implementing an App Actions on Windows provider app using **IActionProvider**, see [Use COM activation with App Actions for Windows
17+
](/windows/ai/app-actions/actions-com-activation).
18+
19+
## -see-also
20+
21+
## -examples
22+
23+

‎windows.ai.actions/actionentityfactory_createremotefileentity_971519456.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A member of the [RemoteFileKind](remotefilekind.md) enumeration specifying the r
2626

2727
### -param sourceUri
2828

29-
The URI of the remote file. Optional. Some cloud storage providers may use the *sourfileIdceId* parameter instead.
29+
The URI of the remote file. Optional. Some cloud storage providers may use the *sourfileId* parameter instead.
3030

3131
### -param fileId
3232

@@ -54,7 +54,7 @@ A new **RemoteFileActionEntity**.
5454

5555
## -remarks
5656

57-
This method has parameters that are commonly used across different cloud providers. The implementation and behavior of these parameters will vary between providers. Action provider developers should consult the documentation for each supported cloud storage provider for usage information for these parameters.
57+
This method has parameters that represent values that are commonly used across different cloud providers. The implementation and behavior of these parameters will vary between providers. App action provider developers should consult the documentation for each supported cloud storage provider for usage information for these parameters.
5858

5959
## -see-also
6060

‎windows.ai.actions/actionentityfactory_createstreamingtextactionentitywriter_700016466.md‎

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

1313
## -description
1414

15-
Creates a new instance of [CreateStreamingTextActionEntityWriter](streamingtextactionentitywriter.md) which supports the [StreamingTextActionEntity](streamingtextactionentity.md) class.
15+
Creates a new instance of [StreamingTextActionEntityWriter](streamingtextactionentitywriter.md) which supports the [StreamingTextActionEntity](streamingtextactionentity.md) class.
1616

1717
## -parameters
1818

‎windows.ai.actions/namedactionentity.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ public sealed class NamedActionEntity : System.IDisposable
1212

1313
## -description
1414

15+
A subclass of [ActionEntity](actionentity.md) that associates the name of an entity with an entity object.
16+
1517
## -remarks
1618

19+
1720
## -see-also
1821

1922
## -examples

‎windows.ai.actions/namedactionentity_close_811482585.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212

1313
## -description
1414

15+
Closes and releases any resources used by this **NamedActionEntity**.
16+
1517
## -remarks
1618

1719
## -see-also

‎windows.ai.actions/namedactionentity_entity.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ public Windows.AI.Actions.ActionEntity Entity { get; set; }
1212

1313
## -description
1414

15-
15+
Gets or sets the action entity that is associated with the value in the [Name](namedactionentity_name.md) property.
1616

1717
## -property-value
1818

19+
An action entity.
20+
1921
## -remarks
2022

2123
## -see-also

0 commit comments

Comments
 (0)