Schemat JSON definicji akcji dla akcji aplikacji na systemie Windows

W tym artykule opisano format pliku JSON definicji akcji dla akcji aplikacji w systemie Windows. Ten plik musi być uwzględniony w projekcie z ustawieniem Akcja kompilacji na "Zawartość" i ustawieniem Skopiuj do katalogu wyjściowego na "Kopiuj, jeśli jest nowsza". Określ ścieżkę względną pakietu do pliku JSON w pliku XML manifestu pakietu. Aby uzyskać więcej informacji, zobacz Format XML manifestu pakietu dostawcy akcji.

Przykładowy plik JSON definicji akcji

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

Definicja akcji: właściwości JSON

W poniższych tabelach opisano właściwości pliku JSON definicji akcji.

Pole Wersja wskazuje wersję schematu, w której wprowadzono właściwość.

Pole PWA wskazuje obsługę dostawców akcji implementowanych jako progresywne aplikacje internetowe (PWA). Aby uzyskać więcej informacji na temat akcji aplikacji za pomocą aplikacji PWA, zobacz Włączanie akcji aplikacji w systemie Windows dla programu PWA.

Katalog główny dokumentu

Akcja

Wynik

Wersja schematu i obsługa programu PWA różnią się w zależności od wartości właściwości kind. Aby uzyskać szczegółowe informacje, zobacz wpis dla każdego typu jednostki.

Kombinacja wejściowa

Wywołanie

Wyliczenie typu ActionEntityKind

Wyliczenie ActionEntityKind określa typy jednostek obsługiwanych przez akcje aplikacji w systemie Windows. W kontekście definicji akcji JSON rodzaje jednostek są literałami ciągu, które rozróżniają wielkość liter.

Właściwości jednostki

Każdy typ jednostki obsługuje co najmniej jedną właściwość, która udostępnia dane instancji dla jednostki. W nazwach właściwości jednostki jest rozróżniana wielkość liter.

Poniższy przykład ilustruje sposób odwoływania się do elementów w ciągu zapytania dla akcji uruchamianych za pośrednictwem aktywacji URI.

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

Aby uzyskać informacje na temat używania właściwości obiektu do tworzenia sekcji warunkowych w JSON definicji akcji, zobacz klauzule Where.

Właściwości jednostki pliku

Właściwości jednostki dokumentu

Jednostka Document obsługuje te same właściwości co Plik.

Właściwości obiektu zdjęcia

Jednostka Zdjęcie obsługuje wszystkie właściwości pliku oprócz następujących właściwości.

Właściwości jednostki tekstowej

Właściwości jednostki StreamingText

Właściwości jednostki RemoteFile

RemoteFileKind, wyliczenie

Wyliczenie RemoteFileKind określa typy plików obsługiwanych dla jednostki RemoteFile .

Właściwości obiektu tabeli

Właściwości podmiotu kontaktu

Klauzule warunków

Format JSON definicji akcji obsługuje klauzule , które mogą służyć do implementowania logiki warunkowej, takie jak określanie, że akcja powinna być wywoływana tylko wtedy, gdy właściwość jednostki ma określoną wartość.

Następujące operatory mogą być używane z klauzulami where .

Klauzule Where używają następującego formatu:

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

W poniższym przykładzie przedstawiono klauzulę where , która daje wartość true, jeśli jednostka File ma rozszerzenie pliku ".txt".

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

Wiele klauzul where można łączyć przy użyciu operatorów logicznych AND i logicznych OR.

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

Powiązane artykuły