CortanaActionableInsights Class

Definition

Derives contextual insights from images or text that let the user learn more about the content, or perform an action based on it.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

public ref class CortanaActionableInsights sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CortanaActionableInsights final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Deprecated("CortanaActionableInsights is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 655360, "Windows.Foundation.UniversalApiContract")]
class CortanaActionableInsights final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class CortanaActionableInsights
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Deprecated("CortanaActionableInsights is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 655360, "Windows.Foundation.UniversalApiContract")]
public sealed class CortanaActionableInsights
Public NotInheritable Class CortanaActionableInsights
Inheritance
Object IInspectable CortanaActionableInsights
Attributes

Windows requirements

Device family
Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v7.0)
App capabilities
cortanaSurface

Remarks

The CortanaActionableInsights class requires the following be added to the Package.appxmanifest:

  • To <Package>
    • xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
    • IgnorableNamespaces="rescap"
  • Under <Capabilities>
    • <rescap:capability name="cortanaSurface"/>

Properties

User

Gets the user associated with the current CortanaActionableInsights object.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

Methods

GetDefault()

Retrieves a CortanaActionableInsights object for the current user.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

GetForUser(User)

Retrieves a CortanaActionableInsights object for the specified user.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

IsAvailableAsync()

Asynchronously retrieves whether insights can be generated on the user's current system.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

ShowInsightsAsync(DataPackage)

Asynchronously retrieves and displays insights based on the specified text and image content.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

ShowInsightsAsync(DataPackage, CortanaActionableInsightsOptions)

Asynchronously retrieves and displays insights based on the specified text and image content and options.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

ShowInsightsForImageAsync(IRandomAccessStreamReference)

Asynchronously retrieves and displays insights based on the specified image content.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

ShowInsightsForImageAsync(IRandomAccessStreamReference, CortanaActionableInsightsOptions)

Asynchronously retrieves and displays insights based on the specified image content and options.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

ShowInsightsForTextAsync(String)

Asynchronously retrieves and displays insights based on the specified text content.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

ShowInsightsForTextAsync(String, CortanaActionableInsightsOptions)

Asynchronously retrieves and displays insights based on the specified text content and options.

Important

The CortanaActionableInsights APIs are a limited access feature. Please contact InsightsAPISupport@microsoft.com for more info, or to request an unlock token.

Applies to

See also