JSON-Schema der Aktionsdefinition für App-Aktionen unter Windows

In diesem Artikel wird das Format des JSON-Dateiformats der Aktionsdefinition für App-Aktionen unter Windows beschrieben. Diese Datei muss in Ihrem Projekt enthalten sein. Die Buildaktion muss auf „Inhalt“ festgelegt sein, und In Ausgabeverzeichnis kopieren muss auf „Kopieren, wenn neuer“ festgelegt sein. Geben Sie den paketrelativen Pfad zur JSON-Datei in der XML-Paketmanifestdatei an. Weitere Informationen finden Sie im XML-Format des Paketmanifests des Aktionsanbieters.

JSON-Beispieldatei der Aktionsdefinition

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

JSON-Eigenschaften der Aktionsdefinition

In den folgenden Tabellen werden die Eigenschaften der JSON-Datei der Aktionsdefinition beschrieben.

Das Feld "Version " gibt die Schemaversion an, in der die Eigenschaft eingeführt wurde.

Das PWA-Feld gibt die Unterstützung für Aktionsanbieter an, die als Progressive Web App (PWA) implementiert werden. Weitere Informationen zu App-Aktionen mit PWAs finden Sie unter Aktivieren von App-Aktionen unter Windows für eine PWA.

Dokumentstamm

Maßnahme

Ausgabe

Die Schemaversion und die PWA-Unterstützung variieren je nach den unterschiedlichen Werten der Art-Eigenschaft . Details finden Sie im Eintrag für jeden Entitätstyp.

Eingabekombination

Aufruf

ActionEntityKind-Enumeration

Die ActionEntityKind-Aufzählung gibt die Typen von Entitäten an, die von App-Aktionen unter Windows unterstützt werden. Im Kontext einer JSON-Aktionsdefinition sind die Entitätstypen Zeichenfolgenliterale, bei denen die Groß-/Kleinschreibung beachtet wird.

Entitätseigenschaften

Jeder Entitätstyp unterstützt eine oder mehrere Eigenschaften, die Instanzdaten für die Entität bereitstellen. Bei den Namen der Entitätseigenschaften wird zwischen Groß- und Kleinschreibung unterschieden.

Das folgende Beispiel veranschaulicht, wie Entitäten in der Abfragezeichenfolge für Aktionen referenziert werden, die über die URI-Aktivierung gestartet werden:

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

Informationen zum Verwenden von Entitätseigenschaften zum Erstellen von bedingten Abschnitten im JSON-Code der Aktionsdefinition finden Sie unter Where-Klauseln.

Entitätseigenschaften für Datei

Eigenschaften der Dokumententität

Die Dokumententität unterstützt dieselben Eigenschaften wie "File".

Eigenschaften der Fotoentität

Die Photo-Entität unterstützt zusätzlich zu den folgenden Eigenschaften alle Eigenschaften von File .

Eigenschaften der Textentität

StreamingText-Entitätseigenschaften

Eigenschaften der RemoteFile-Entität

RemoteFileKind-Aufzählung

Die RemoteFileKind-Aufzählung gibt die Dateitypen an, die für die RemoteFile-Entität unterstützt werden.

Eigenschaften von Tabelleneinheiten

Kontaktentitätseigenschaften

Where-Klauseln

Das JSON-Format der Aktionsdefinition unterstützt , wo Klauseln verwendet werden können, mit denen bedingte Logik implementiert werden kann, z. B. die Angabe, dass eine Aktion nur aufgerufen werden soll, wenn eine Entitätseigenschaft einen angegebenen Wert aufweist.

Die folgenden Operatoren können mit WHERE-Klauseln verwendet werden.

Dabei verwenden Klauseln das folgende Format:

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

Das folgende Beispiel zeigt eine Where-Klausel, die als „wahr“ ausgewertet wird, wenn eine File-Entität die Dateierweiterung „.txt“ aufweist.

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

Mehrere WHERE-Bedingungen können mit den logischen Und- und Oder-Operatoren kombiniert werden.

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

Verwandte Artikel