JSON-schema voor actiedefinitie voor app-acties in Windows

In dit artikel wordt de indeling van de JSON-bestandsindeling van de actiedefinitie voor app-acties in Windows beschreven. Dit bestand moet worden opgenomen in uw project met de buildactie ingesteld op 'Inhoud' en Kopiëren naar uitvoermap ingesteld op 'Kopiëren als nieuwer'. Geef het pakket-relatieve pad op naar het JSON-bestand in het XML-bestand van het pakketmanifest. Zie de XML-indeling voor het pakketmanifest van de Action Provider voor meer informatie.

JSON-voorbeeldactiedefinitiebestand

"version": 3, 
  "actions": [ 
    { 
      "id": "Contoso.SampleGreeting", 
      "description": "Send greeting with Contoso", 
      "icon": "ms-resource//...",
      "displaysUI": false, 
      "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-eigenschappen van de actiedefinitie

In de onderstaande tabellen worden de eigenschappen van het JSON-bestand met de actiedefinitie beschreven.

Het veld Versie geeft de schemaversie aan waarin de eigenschap is geïntroduceerd.

Het veld PWA geeft ondersteuning aan voor actieproviders die zijn geïmplementeerd als een Progressive Web App (PWA). Zie App-acties inschakelen op Windows voor een PWA voor meer informatie over app-acties met PWA's.

Hoofdmap van document

Handeling

Uitvoer

De schemaversie en PWA-ondersteuning variëren voor de verschillende waarden van de soort eigenschap. Zie de vermelding voor elk entiteitstype voor meer informatie.

Invoervariant

Aanroep

Opsomming van ActionEntityKind

De opsomming ActionEntityKind geeft de typen entiteiten op die worden ondersteund door App Actions in Windows. In de context van een JSON-actiedefinitie zijn de entiteitstypen letterlijke tekenreeksen die hoofdlettergevoelig zijn.

Entiteitseigenschappen

Elk entiteitstype ondersteunt een of meer eigenschappen die instantiegegevens voor de entiteit bieden. De namen van entiteitseigenschappen zijn hoofdlettergevoelig.

In het volgende voorbeeld ziet u hoe naar entiteiten wordt verwezen in de querytekenreeks voor acties die worden gestart via URI-activering:

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

Zie Where-componenten voor informatie over het gebruik van entiteitseigenschappen voor het maken van voorwaardelijke secties in de JSON-actiedefinitie.

Eigenschappen van bestandsentiteit

Eigenschappen van documententiteiten

De entiteit Document ondersteunt dezelfde eigenschappen als Bestand.

Eigenschappen van foto-entiteit

De entiteit Photo ondersteunt naast de volgende eigenschappen alle eigenschappen van Bestand .

Eigenschappen van tekstentiteit

Eigenschappen van StreamingText-entiteit

Eigenschappen van remoteFile-entiteit

Enumeratie RemoteFileKind

Met de opsomming RemoteFileKind worden de typen bestanden opgegeven die worden ondersteund voor de entiteit RemoteFile .

Eigenschappen van tabelentiteit

Eigenschappen van contactpersoonentiteit

Where-clausules

De JSON-indeling van de actiedefinitie ondersteunt waar componenten kunnen worden gebruikt voor het implementeren van voorwaardelijke logica, zoals het opgeven dat een actie alleen moet worden aangeroepen wanneer een entiteitseigenschap een opgegeven waarde heeft.

De volgende operators kunnen worden gebruikt met where-componenten .

Waar clausules gebruiken de volgende indeling:

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

In het volgende voorbeeld ziet u een where-clausule die waar evalueert als een bestand de bestandsextensie ".txt" heeft.

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

Meerdere where-componenten kunnen worden gecombineerd met behulp van de logische EN- en logische OR-operators.

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

Verwante artikelen