Schéma JSON de définition d’action pour Les actions d’application sur Windows

Cet article décrit le format du format de fichier JSON de définition d’action pour Les actions d’application sur Windows. Ce fichier doit être inclus dans votre projet avec l’action de génération définie sur « Contenu » et copier dans le répertoire de sortie défini sur « Copier si plus récent ». Spécifiez le chemin d’accès relatif au package du fichier JSON dans votre fichier XML du manifeste du package. Pour plus d’informations, consultez le format XML du manifeste du package du fournisseur d’actions.

Exemple de fichier JSON de définition d’action

"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": "{...}" 
      } 
    } 
  ] 
} 

Propriétés JSON de définition d’action

Les tableaux ci-dessous décrivent les propriétés du fichier JSON de définition d’action.

Le champ Version indique la version du schéma dans laquelle la propriété a été introduite.

Le champ PWA indique la prise en charge des fournisseurs d’actions implémentés en tant qu’application web progressive (PWA). Pour plus d’informations sur les actions d’application avec des PWA, consultez Activer les actions d’application sur Windows pour une application PWA.

Racine du document

Action

Sortie

La version du schéma et la prise en charge PWA varient selon les différentes valeurs de la propriété de type . Pour plus d’informations, consultez l’entrée de chaque type d’entité.

Combinaison entrée

Appel

Énumération ActionEntityKind

L’énumération ActionEntityKind spécifie les types d’entités prises en charge par Les actions d’application sur Windows. Dans le contexte d’une définition d’action JSON, les types d’entités sont des littéraux de chaîne qui respectent la casse.

Propriétés d’entité

Chaque type d’entité prend en charge une ou plusieurs propriétés qui fournissent des données d’instance pour l’entité. Les noms de propriété d’entité respectent la casse.

L’exemple suivant montre comment les entités sont référencées dans la chaîne de requête pour les actions lancées via l’activation de l’URI :

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

Pour plus d’informations sur l’utilisation des propriétés d’entité pour créer des sections conditionnelles dans la définition d’action JSON, consultez les clauses Where.

Propriétés d’entité de fichier

Propriétés d’entité de document

L’entité Document prend en charge les mêmes propriétés que File.

Propriétés de l’entité photo

L’entité Photo prend en charge toutes les propriétés de File en plus des propriétés suivantes.

Propriétés de l’entité de texte

Propriétés de l’entité StreamingText

Propriétés de l’entité RemoteFile

RemoteFileKind, énumération

L’énumération RemoteFileKind spécifie les types de fichiers pris en charge pour l’entité RemoteFile .

Propriétés d’entité de table

Propriétés de l’entité contact

Clauses WHERE

Le format JSON de définition d’action prend en charge les clauses qui peuvent être utilisées pour implémenter une logique conditionnelle, par exemple en spécifiant qu’une action doit être appelée uniquement lorsqu’une propriété d’entité a une valeur spécifiée.

Les opérateurs suivants peuvent être utilisés avec les clauses Where .

Les clauses Where utilisent le format suivant :

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

L’exemple suivant montre une clause where qui prend la valeur true si une entité File a l’extension de fichier «.txt».

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

Plusieurs clauses where peuvent être combinées avec les opérateurs logiques ET et OU.

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

Articles connexes