Habilitar las acciones de la aplicación en Windows para una PWA

Puede crear y probar una acción de aplicación para las acciones de la aplicación en Windows Framework, para una aplicación web progresiva (PWA) que haya creado. Una acción de aplicación en Windows es una unidad individual de comportamiento que una aplicación de Windows puede implementar y registrar. A continuación, se puede acceder a la acción de la aplicación desde otras aplicaciones y experiencias, integrándose sin problemas en los flujos de trabajo del usuario.

Contenido detallado:

Introducción

Una aplicación compila y registra cada acción de la aplicación y, a continuación, las aplicaciones y experiencias de Windows pueden recomendar acciones de aplicación registradas al usuario en momentos y ubicaciones contextualmente relevantes dentro del flujo de trabajo del usuario.

Puedes crear acciones de Aplicación de Windows para aumentar la detectabilidad y la interacción de las características de la aplicación.

Vea también:

El marco de acciones de Aplicación de Windows sirve para exponer y ejecutar partes clave de la funcionalidad de la aplicación, no para actividades genéricas del usuario, como abrir un menú contextual (menú contextual). Consulte los escenarios recomendados para Acciones de aplicación en Información general de Acciones de aplicación en Windows.

Definir las acciones de la aplicación en el manifiesto de definición de acción

Debe definir las acciones de la aplicación que admite su PWA en un archivo de manifiesto de definición de acción (como ActionsManifest.json). Este es un archivo JSON de definición de acción para acciones de aplicación en Windows.

El presente artículo muestra cómo crear una acción de aplicación que usa PWA de ejemplo, wami, la aplicación web para manipular imágenes. La demostración wami admite tareas de manipulación de imágenes, como cambiar el tamaño o aplicar estilos de posprocesamiento.

El siguiente archivo de manifiesto de definición de acción de ejemplo (denominado ActionsManifest.json) define una acción de la aplicación Paint para la característica Paint de la aplicación de ejemplo wami. La característica Paint, a la que hace referencia la acción de la aplicación Paint , genera una versión de la imagen con estilo de pintura al óleo.

{
   "version": 1,
   "actions": [{
      "id": "Wami.Paint",
      "description": "Convert the image to oil paint style",
      "kind": "Search",
      "inputs": [{
         "name": "File",
         "kind": "Photo"
        }],
      "outputs": [],
      "invocation": {
         "type": "Uri",
         "uri": "web+wami://paint"
      },
      "inputCombinations": [{
         "inputs": [ "File" ],
         "description": "Photo to be converted to oil paint style."
      }]
   }]
}

Como entrada, la acción de la aplicación Paint acepta el archivo de imagen que el usuario seleccionó.

La acción de la aplicación Paint devuelve la salida estilizada.

Propiedades admitidas en un manifiesto de definición de acción

El archivo de manifiesto de definición de acción (comoActionsManifest.json) es un archivo descriptivo que utiliza Aplicación de Windows Actions Runtime para una aplicación con el fin de declarar las acciones de la aplicación compatibles.

Para ver la definición de cada propiedad JSON admitida, consulte Definición de acción Propiedades JSON en Definición de acción Esquema JSON para acciones de aplicaciones en Windows.

En Invocation, solo se admite el uri tipo. Este com tipo no es aplicable a las PWA.

Tipos de entidad admitidos para acciones de aplicación para PWA

En el archivo de manifiesto de definición de acción (como ActionsManifest.json), la ActionEntityKind enumeración especifica los tipos de entidades que admiten las acciones de aplicación en Windows.

En el contexto de una definición de acción de aplicación JSON, los tipos de entidad son literales de cadena que distinguen mayúsculas de minúsculas. Las entidades admitidas se enumeran en la enumeración ActionEntityKind en el esquema JSON de definición de acciones para acciones de aplicación en Windows.

StreamingText y RemoteFile aún no se admiten para PWA. Para , File, y Text los tipos de entidad, consulte Propiedades de entidad en Definición de acción Esquema JSON para Acciones de aplicación en Windows. PhotoDocument

Cómo se lanza una PWA a través de la activación de URI

Cuando se llama a una acción de aplicación de PWA, Windows inicia la acción de aplicación de PWA a través de la activación URI de protocolo personalizado. Una PWA debe registrarse para el control de protocolo personalizado mediante el protocol_handlers campo del manifiesto de la aplicación web de PWA, como Demos/wami/manifest.json.

Action Framework usa el método de LaunchUriAsync(Uri, LauncherOptions, ValueSet) Windows para la activación de URI. LaunchUriAsync No devuelve ningún valor o estado de error.

uri En el manifiesto de definición de acción

Use un URI de protocolo personalizado, no un URI HTTPS.

Para una PWA que tiene varias acciones de la aplicación, use la sintaxis:

"uri": "web+{app name}://{custom action name}"

Por ejemplo:

"uri": "web+wami://paint"

La línea anterior se muestra en contexto en Definir acciones de la aplicación en el manifiesto de definición de acción anterior.

Recibir ValueSet datos y asignarlos a un destino de uso compartido

El URI del protocolo activado se asignará al url campo de los datos de destino del recurso compartido.

La entrada ValueSet se convertirá en una cadena JSON válida y se asignará al text campo de los datos de destino del recurso compartido. Esto permite a Microsoft Edge determinar que el inicio del controlador de protocolo representa una acción de la aplicación.

El manifiesto de la aplicación web de la aplicación (como Demos/wami/manifest.json) debe configurar correctamente el campo para permitir que se inicie como destino de uso compartido para una acción de la share_target aplicación. Consulte share_target el siguiente manifiesto de la aplicación web.

Requisitos previos para que su PWA admita las acciones de la aplicación

Para integrar correctamente la PWA con las acciones de aplicación en Windows Framework, se requieren los siguientes miembros del manifiesto de la aplicación web:

  • share_target
  • protocol_handlers
  • launch_handler

share_target En el manifiesto de la aplicación web

Para que una PWA use acciones de aplicación, el share_target campo debe estar presente en el archivo de manifiesto de la aplicación web de PWA, como Demos/wami/manifest.json.

  • El método debe ser "POST".
  • El enctype debe ser multipart/form-data.
  • text y url in params son necesarios para admitir las acciones de la aplicación.
  • files es opcional. Puede omitirlo files si no desea que la PWA admita la característica de destino de uso compartido normal.

Declaración de ejemplo share_target , de Demos/wami/manifest.json:

"share_target": {
   "action": "./share-target",
   "method": "POST",
   "enctype": "multipart/form-data",
   "params": {
      "title": "title",
      "text": "text",
      "url": "url"
   }
}

Vea también:

Controlar la entidad de una acción de aplicación

La entidad de una acción de aplicación se pasa a la PWA a través de los datos del recurso compartido POST. Para administrar los datos del recurso compartido POST, puede usar o combinar los siguientes métodos:

El siguiente código procede del controlador de trabajo de servicio de ejemplo de la demostración wami en Demos/wami/sw.js, para admitir el inicio de acciones de aplicación para la aplicación:

// Extract data
const data = {
   text: formData.get('text') || '',
   url: formData.get('url') || ''
};
const files = formData.getAll('windowsActionFiles');

Explicación de las formData claves:

  • Texto: Cadena JSON que enumera todas las entidades de entrada. El valor del parámetro de entrada debe ser idéntico al valor que estableció en el manifiesto share_target.params.textde la aplicación web de PWA. El uso seguro de las rutas de acceso de archivo contenidas en el texto es seguro. Para proteger la privacidad de los usuarios, Edge desinfecta cualquier información de ruta proporcionada por el usuario antes de que llegue al trabajo de servicio, dejando solo el nombre de archivo.

  • Dirección URL: El URI de protocolo (por ejemplo, en el ejemplo) web+wami://paint que identifica qué acción de la aplicación desencadenó el inicio. El valor del parámetro de entrada debe ser idéntico al valor que estableció en el manifiesto share_target.params.urlde la aplicación web de PWA.

  • archivos: Objetos de archivo adjuntos a la invocación de la acción de aplicación.

protocol_handlers En el manifiesto de la aplicación web

Para que una PWA use acciones de aplicación, el protocol_handlers campo debe estar presente en el archivo de manifiesto de la aplicación web de la PWA (como Demos/wami/manifest.json). El protocol_handlers.protocol campo debe coincidir con la primera parte del archivo de manifiesto de definición de invocation.uri acción (por ActionsManifest.jsonejemplo, ).

Declaración de ejemplo protocol_handlers , de Demos/wami/manifest.json:

"protocol_handlers": [{
   "protocol": "web+wami",
   "url": "./?url=%s"
}]

El campo coincidente invocation.uri de ActionsManifest.json:

"invocation": {
   "type": "Uri",
   "uri": "web+wami://paint"
},

El fragmento anterior se muestra en contexto en Definir acciones de la aplicación en el manifiesto de definición de acción anterior.

Vea también:

launch_handler En el manifiesto de la aplicación web

Si desea mantener una única ventana de PWA, puede establecer launch_handler como navigate-existing en el archivo de manifiesto de la aplicación web de PWA (como Demos/wami/manifest.json).

Declaración de ejemplo:

"launch_handler": {
   "client_mode": " navigate-existing"
}

El código anterior no está en Demos/wami/manifest.json.

Empaquetar una tienda PWA en Edge Estable

A continuación, las PWA deben empaquetarse como una PWA de Microsoft Store, para que el marco de acciones de Aplicación de Windows la llame.

Para empaquetar tu PWA como una PWA de Microsoft Store:

  1. Empaqueta tu PWA para PWABuilder.com; consulte Empaquetar la PWA para Store en Publicar una PWA en Microsoft Store.

  2. En Toda la configuración, desplácese hacia abajo hasta Acciones: Habilitar acciones en la parte inferior.

  3. Asegúrese de que el archivo de manifiesto de la aplicación web de PWA (como Demos/wami/manifest.json) tiene protocol_handlers y share_target campos. PWABuilder.com ejecutará una comprobación y, si falta alguno de los campos en el manifiesto de la aplicación web de la aplicación, la casilla Habilitar acciones aparecerá atenuada.

  4. En la sección Acciones , haz clic en Elegir archivo y carga el archivo de manifiesto de definición de acción (como ActionsManifest.json, por ejemplo, ) que preparaste para tu PWA.

  5. Haz clic en el botón Descargar .

  6. Descomprime el archivo de descargas. Instálelo ejecutando install.ps1.

  7. Inicie la PWA haciendo clic en el icono de PWA.

  8. Pruebe sus acciones de PWA localmente siguiendo Probar acciones de aplicación para una PWA, a continuación, para validar la funcionalidad.

  9. Abre el archivo de manifiesto de definición de acción (por ejemplo ActionsManifest.json, ) que usó al empaquetar en PWAbuilder.com.

  10. Establece la disponibilidad inicial de cada una de las acciones de la aplicación en false, como se describe en Establecer la disponibilidad inicialen Alternar la disponibilidad de una acción de aplicación para Windows.

  11. Publique su PWA, como se describe en Publicar una PWA en Microsoft Store.

Empaquetar una tienda PWA en Edge Canary

Edge Canary ofrece una vista previa de las funcionalidades que aún no está disponible en estable.

Si desea probar las últimas funcionalidades de Acciones de aplicación en Edge Canary, puede empaquetar su PWA en Edge Canary de la siguiente manera:

  1. Instale Edge Canary y actualice a la versión más reciente.

  2. Obtener el identificador de paquete, el identificador de editor y el nombre para mostrar del publicador de su PWA; consulte Publicar una PWA en Microsoft Store.

  3. Vaya al probador PWABuilder.Windows.Chromium.

  4. Escriba la configuración de PWA en el cuadro de entrada, para los campos siguientes:

    • name: el nombre de su PWA.
    • packageId: no es necesario si no va a publicar la versión Canary de Edge de la aplicación en la tienda. Puede ser una cadena vacía.
    • url: La dirección URL de la PWA.
    • publisher.displayName: El nombre de la editorial. No es necesario si no va a publicar la versión Canary de Edge de la aplicación en la tienda. Puede ser una cadena vacía.
    • publisher.commonName: su id. de editor. No es necesario si no va a publicar la versión Canary de Edge de la aplicación en la tienda. Puede ser una cadena vacía.
    • startUrl: Sus PWA startUrl.

    Ejemplo de lista JSON que puede copiar y pegar en el campo de texto del probador PWABuilder.Windows.Chromium:

    {
       "name": "Wami for Canary",
       "packageId": "",
       "url": "https://microsoftedge.github.io/Demos/wami",
       "version": "1.0.2",
       "allowSigning": true,
       "classicPackage": {
          "generate": true,
          "version": "1.0.0"
       },
       "publisher": {
          "displayName": "",
          "commonName": ""
       },
       "edgeChannel": "canary",
       "appUserModelId": "Microsoft.Canary_8wekyb3d8bbwe!MSEDGE",
       "generateModernPackage": true,
       "resourceLanguage": "EN-US",
       "startUrl": "https://microsoftedge.github.io/Demos/wami"
    }
    

    Reemplace los atributos anteriores por los atributos reales de la aplicación.

  5. Carga el archivo de manifiesto de definición de acción (por ActionsManifest.jsonejemplo, ) y luego haz clic en el botón Descargar .

  6. La descarga es un .zip archivo que contiene archivos como, por ejemplo .msix , archivos y .msixbundle . Descomprímelo y ejecútalo install.ps1 para instalar tu PWA directamente.

  7. Haga clic en el icono de su PWA.

    Se iniciará la PWA.

  8. Inicia Edge Canary y, a continuación, ve a edge://apps.

    Se muestra su PWA.

  9. Haga clic en el botón Detalles .

    Su PWA se indica como instalada desde Microsoft Store.

Su PWA ahora se ha instalado como una PWA de tienda en Edge Canary.

Probar acciones de aplicación para una PWA

Para probar las acciones de la aplicación para su PWA:

  1. Asegúrese de que la PWA se ha configurado y empaquetado correctamente, como se explica en las secciones anteriores.

  2. Asegúrate de que Windows está actualizado para admitir las acciones de la aplicación; consulte la compilación 26120.4151 de Windows 11 Insider Preview (canal beta).

  3. Asegúrese de que Microsoft Edge esté actualizado a la última versión e instale correctamente la PWA. consulte Empaquetar una PWA de la tienda en Edge estable o Empaquetar una PWA de la tienda en Edge Canary, arriba.

  4. Inicie Edge Canary o Edge Stable (el canal en el que haya instalado la PWA).

  5. Inicie su PWA.

    La PWA debe iniciarse al menos una vez para inicializar la PWA para la acción de la aplicación, antes de que el tiempo de ejecución de las acciones de la aplicación la llame.

  6. Use la aplicación del Sitio de prueba de acciones de aplicaciones para probar las acciones de la aplicación para su PWA.

  7. Agrega la entidad que necesita la acción de la aplicación. Por ejemplo, si la acción de la aplicación procesa imágenes, agrega una imagen. A continuación, ejecute la acción de la aplicación.

    Se inicia la PWA y ejecuta la acción de la aplicación.

Vea también

Artículos de Windows:

Sitios:

MDN:

repositorio de demostraciones: