Share via

ActionDefinition Class

Definition

Namespace:
Windows.AI.Actions.Hosting
Edit

Provides details about the app action definition.

public ref class ActionDefinition sealed : IClosable
/// [Windows.Foundation.Metadata.ContractVersion(Windows.AI.Actions.ActionsContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ActionDefinition final : IClosable
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.AI.Actions.ActionsContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ActionDefinition : System.IDisposable
Public NotInheritable Class ActionDefinition
Implements IDisposable
Inheritance
Object Platform::Object IInspectable ActionDefinition
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute
Implements
IClosable IDisposable

Windows requirements

Requirements Description
Device family
Windows Desktop Extension SDK (introduced in 10.0.26100.0)
API contract
Windows.AI.Actions.ActionsContract (introduced in v8.0)

Remarks

Actions are defined using JSON syntax that specifies information about the action such as a unique identifier, a description, and the set of inputs that it accepts. For information about the JSON syntax for defining an action, see Action definition JSON schema for App Actions on Windows.

Properties

Name Description
Description

Gets the description of the app action.
DisplaysUI

Gets a value indicating whether the app action displays UI.
IconFullPath

Gets the full path to the icon for the app action.
Id

Gets the unique identifier for the app action.
IsCurrentlyAvailable
PackageFamilyName

Gets the Package Family Name (PFN) for the app action provider app.
PackageRelativeApplicationId

Gets the package-relative application ID for the app action provider app.
SchemaVersion

Gets a value that specifies the action definition JSON schema version used by the app action.
UsesGenerativeAI

Gets a value indicating whether the app action uses generative AI.

Methods

Name Description
Close()

Closes and releases any resources used by this ActionDefinition.
Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetIconFullPath(PropertySet)
GetInputs()

Gets an array of objects describing the input entities accepted by an app action.
GetOutputs()

Gets an array of objects describing the output entities returned from an app action.
GetOverloads()

Gets an array of overloads of an app action, each of which accepts a different set of inputs.

Applies to