Esquema JSON de definición de acción para acciones de aplicación en Windows

En este artículo se describe el formato del formato de archivo JSON de definición de acción para Acciones de aplicación en Windows. Este archivo debe incluirse en el proyecto con Build Action definido con el valor "Content" y con Copy to Output Directory con el valor “Copy if newer”. Especificar en el fichero XML del manifiesto del paquete la ruta al archivo JSON relativa al paquete. Para más información, véase Formato XML del manifiesto de paquete del proveedor de acciones.

Archivo JSON de definición de acción de ejemplo

"version": 3, 
  "actions": [ 
    { 
      "id": "Contoso.SampleGreeting", 
      "description": "Send greeting with Contoso", 
      "icon": "ms-resource//...", 
      "usesGenerativeAI": false,
      "isAvailable": false,
      "allowedAppInvokers": ["*"],
      "inputs": [ 
        { 
          "name": "UserFriendlyName", 
          "kind": "Text" 
        }, 
        { 
          "name": "PetName", 
          "kind": "Text", 
          "required": false 
        } 
      ], 
      "inputCombinations": [ 
        { 
          "inputs": ["UserFriendlyName"], 
          "description": "Greet ${UserFriendlyName.Text}" 
        }, 
        { 
          "inputs": ["UserFriendlyName", "PetName"], 
          "description": "Greet ${UserFriendlyName.Text} and their pet ${PetName.Text}" 
        } 
      ], 
      "contentAgeRating": "child",  
      "invocation": 
      {
        { 
          "type": "Uri", 
          "uri": "contoso://greetUser?userName=${UserFriendlyName.Text}&petName=${PetName.Text}", 
        }, 
        "where": [ 
          "${UserFriendlyName.Length > 3}" 
        ] 
      } 
    }, 
    { 
      "id": "Contoso.SampleGetText", 
      "description": "Summarize file with Contoso", 
      "icon": "ms-resource://...", 
      "inputs": [ 
        { 
          "name": "FileToSummarize", 
          "kind": "File" 
        } 
      ], 
      "inputCombinations": [ 
        { 
          "inputs": ["FileToSummarize"], 
          "description": "Summarize ${FileToSummarize.Path}" 
        }, 
      ], 
      "outputs": [ 
        { 
          "name": "Summary", 
          "kind": "Text" 
        } 
      ],
      "contentAgeRating": "child", 
      "invocation": { 
        "type": "COM", 
        "clsid": "{...}" 
      } 
    } 
  ] 
} 

Propiedades JSON de definición de acción

Las siguientes tablas describen las propiedades del fichero JSON de definición de acciones.

El campo Versión indica la versión del esquema en la que se introdujo la propiedad.

El campo PWA indica compatibilidad con proveedores de acciones que se implementan como una aplicación web progresiva (PWA). Para obtener más información sobre las acciones de aplicación con PWA, consulte Habilitar acciones de aplicación en Windows para una PWA.

Raíz del documento

Acción

Salida

La versión del esquema y la compatibilidad con PWA varían para los distintos valores de la propiedad kind . Consulte la entrada de cada tipo de entidad para obtener más información.

Combinación de Entrada

Invocación

Enumeración ActionEntityKind

La enumeración ActionEntityKind especifica los tipos de entidades compatibles con Acciones de aplicación en Windows. En el contexto de una definición de acción en JSON, los tipos de entidades son literales de cadena en los que se distingue entre mayúsculas y minúsculas.

Propiedades de entidad

Cada tipo de entidad admite una o más propiedades que proporcionan datos de instancia de la entidad. Los nombres de propiedad de entidad distinguen entre mayúsculas y minúsculas.

El siguiente ejemplo muestra cómo se referencian en la cadena de consulta las entidades para las acciones que se arrancan mediante activación URI:

...?param1=${entityName.property1}&param2=${entityName.property2}

Para obtener información sobre el uso de propiedades de entidad para crear secciones condicionales en el JSON de definición de acción, consulte Cláusulas Where.

Propiedades de la entidad archivo

Propiedades de entidad de documento

La entidad Document admite las mismas propiedades que File.

Propiedades de la entidad fotográfica

LA entidad Photo admite todas las propiedades de File además de las siguientes propiedades.

Propiedades de la entidad Text

Propiedades de la entidad StreamingText

Propiedades de entidad RemoteFile

Enumeración RemoteFileKind

La enumeración RemoteFileKind especifica los tipos de archivos que se admiten para la entidad RemoteFile .

Propiedades de entidad de tabla

Propiedades de entidad de contacto

Cláusula where

El formato JSON de definición de acción admite donde se pueden usar cláusulas para implementar lógicas condicionales, como especificar que una acción deba ser invocada solo si una cierta propiedad de una entidad toma un determinado valor.

Los siguientes operadores se pueden usar con donde cláusulas.

Donde las cláusulas utilizan el siguiente formato:

"where": [ 
    "${<property_accessor>} <operator> <value>" 
] 

El siguiente ejemplo muestra una donde la cláusula pone a true si una entidad File tiene la extensión de archivo ".txt".

"where": [ 
    "${File.Extension} ~= \".txt\"" 
] 

Varias donde cláusulas pueden combinarse mediante los operadores lógicos AND y OR.

"where": [ 
  "${File.Extension} ~= \".txt\" || ${File.Extension} ~= \".md\"" 
] 

Artículos relacionados