AppTaskInfo Class

Definition

public ref class AppTaskInfo sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.UI.Shell.Tasks.AppTaskContract, 65536)]
/// [Windows.Foundation.Metadata.Experimental]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AppTaskInfo final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.UI.Shell.Tasks.AppTaskContract), 65536)]
[Windows.Foundation.Metadata.Experimental]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AppTaskInfo

Public NotInheritable Class AppTaskInfo

Inheritance

Object Platform::Object IInspectable AppTaskInfo

Attributes

ContractVersionAttribute ExperimentalAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Remarks

This class supports creating, updating, and removing task representations. Tasks are persisted across app sessions and system reboots.

For each task, create a new AppTaskInfo instance and modify it to represent the task state. When a task is no longer relevant, call Remove to remove it from the Shell.

Use IsSupported to check if the feature is available before attempting to create or enumerate tasks. Use FindAll to enumerate existing tasks that were created previously.

Tasks can be hidden by users through the taskbar interface. Hiding a task does not affect the task running in the app; its representation is simply removed from the taskbar. The HiddenByUser property indicates whether a task has been hidden by the user.

Using shell tasks APIs

Apps that use these APIs need to be packaged. See Packaging overview for more info.

You also need to add the com.microsoft.apptaskprovider AppExtension to your app manifest like this:

<Package
  xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
  xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
  xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
  xmlns:uap3="http://schemas.microsoft.com/appx/manifest/uap/windows10/3"
  IgnorableNamespaces="rescap uap uap3">
...

<Application>
  ...
  <Extensions>
    <uap3:Extension Category="windows.appExtension">
        <uap3:AppExtension
            Name="com.microsoft.apptaskprovider"
            PublicFolder="Public"
            Id="MyApp.AppTaskProvider"
            DisplayName="AppTaskProvider for MyApp"/>
    </uap3:Extension>
  </Extensions>
  ...
</Application>

...
</Package>