Criar extensões de aplicativo para aplicativos SDK do Aplicativo Windows

As extensões de aplicativo permitem que seu aplicativo hospede conteúdo e funcionalidade de complementos de outros pacotes. Esse é o Windows equivalente a um modelo de plug-in. Um provedor de extensão declara conteúdo ou serviços e seu aplicativo host os descobre e os carrega em runtime.

Como funcionam as extensões de aplicativo

O modelo de extensão do aplicativo tem duas funções:

• Host de extensões — Seu aplicativo declara quais tipos de extensões aceita e descobre as extensões instaladas.
• Provedor de extensão — Outro aplicativo (ou o mesmo aplicativo) declara que ele fornece uma extensão de um tipo específico.

As extensões se comunicam por meio das declarações de manifesto do pacote, não por meio do código. O aplicativo host usa a API AppExtensionCatalog para localizar e gerenciar extensões instaladas.

Declarar um host de extensão

Adicione uma declaração AppExtensionHost ao seu aplicativo Package.appxmanifest:

<Package xmlns:uap3="http://schemas.microsoft.com/appx/manifest/uap/windows10/3" ...>
  <Applications>
    <Application ...>
      <Extensions>
        <uap3:Extension Category="windows.appExtensionHost">
          <uap3:AppExtensionHost>
            <uap3:Name>com.example.myapp.extensions</uap3:Name>
          </uap3:AppExtensionHost>
        </uap3:Extension>
      </Extensions>
    </Application>
  </Applications>
</Package>

Declarar um provedor de extensão

No Package.appxmanifestaplicativo da extensão:

<Package xmlns:uap3="http://schemas.microsoft.com/appx/manifest/uap/windows10/3" ...>
  <Applications>
    <Application ...>
      <Extensions>
        <uap3:Extension Category="windows.appExtension">
          <uap3:AppExtension Name="com.example.myapp.extensions"
                             Id="MathExtension"
                             DisplayName="Math Functions"
                             Description="Provides math operations"
                             PublicFolder="Public">
          </uap3:AppExtension>
        </uap3:Extension>
      </Extensions>
    </Application>
  </Applications>
</Package>

O PublicFolder aponta para uma pasta no pacote da extensão que o aplicativo hospedeiro pode ler.

Descobrir e carregar extensões

Em seu aplicativo host, use AppExtensionCatalog para descobrir extensões instaladas:

private AppExtensionCatalog? _catalog;

private async Task InitializeExtensionsAsync()
{
    _catalog = AppExtensionCatalog.Open("com.example.myapp.extensions");

    _catalog.PackageInstalled += OnExtensionInstalled;
    _catalog.PackageUpdated += OnExtensionUpdated;
    _catalog.PackageUninstalling += OnExtensionRemoved;

    var extensions = await _catalog.FindAllAsync();
    foreach (var extension in extensions)
    {
        await LoadExtensionAsync(extension);
    }
}

private async Task LoadExtensionAsync(AppExtension extension)
{
    string extensionId = extension.Id;
    string displayName = extension.DisplayName;

    // Get the extension's public folder
    var folder = await extension.GetPublicFolderAsync();
    if (folder != null)
    {
        // Read configuration, content, or scripts from the folder
        var configFile = await folder.TryGetItemAsync("config.json");
        if (configFile != null)
        {
            // Parse and use the extension configuration
        }
    }
}

// See "Handle extension lifecycle events" below for the
// OnExtensionInstalled, OnExtensionUpdated, and OnExtensionRemoved handlers.
private async void OnExtensionInstalled(AppExtensionCatalog sender,
    AppExtensionPackageInstalledEventArgs args) { }
private async void OnExtensionUpdated(AppExtensionCatalog sender,
    AppExtensionPackageUpdatedEventArgs args) { }
private void OnExtensionRemoved(AppExtensionCatalog sender,
    AppExtensionPackageUninstallingEventArgs args) { }

Lidar com eventos do ciclo de vida da extensão

private async Task LoadExtensionAsync(AppExtension extension) => await Task.CompletedTask;
// (See "Discover and load extensions" above for the real implementation.)

private async void OnExtensionInstalled(AppExtensionCatalog sender,
    AppExtensionPackageInstalledEventArgs args)
{
    // Re-query the catalog to get the AppExtension instances added by this package
    var extensions = await sender.FindAllAsync();
    foreach (var extension in extensions.Where(e => e.Package.Id.FamilyName == args.Package.Id.FamilyName))
    {
        await LoadExtensionAsync(extension);
    }
}

private void OnExtensionRemoved(AppExtensionCatalog sender,
    AppExtensionPackageUninstallingEventArgs args)
{
    // args.Package identifies the package that is uninstalling
    string familyName = args.Package.Id.FamilyName;
    // Remove any extensions from that package from your app
}

private async void OnExtensionUpdated(AppExtensionCatalog sender,
    AppExtensionPackageUpdatedEventArgs args)
{
    // Re-query the catalog to get the refreshed AppExtension instances
    var extensions = await sender.FindAllAsync();
    foreach (var extension in extensions.Where(e => e.Package.Id.FamilyName == args.Package.Id.FamilyName))
    {
        // Reload with updated content
        await LoadExtensionAsync(extension);
    }
}

Conteúdo relacionado

• Extensões de pacote
• Visão geral da extensibilidade
• Serviços de aplicativo
• Classe AppExtensionCatalog