Windows 上應用程式動作的動作定義 JSON 架構

本文說明 Windows 上應用程式動作的動作定義 JSON 檔案格式格式。 此檔案必須包含在您的專案中，將 [建置動作] 設定為「內容」，並將 [複製到輸出目錄] 設定為「如果更新則複製」。 在封裝指令清單 XML 檔案中，指定 JSON 檔案的套件相對路徑。 如需詳細資訊，請參閱 動作提供者套件指令清單 XML 格式。

動作定義 JSON 檔案範例

"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 屬性

下表描述動作定義 JSON 檔案的屬性。

此 版本 欄位指出引進屬性的結構描述版本。

PWA 欄位指出支援實作為漸進式 Web 應用程式 （PWA） 的動作提供者。 如需使用 PWA 的應用程式動作的詳細資訊，請參閱 在 Windows 上啟用 PWA 的應用程式動作。

檔根目錄

行動

輸出

架構版本和 PWA 支援會因 kind 屬性的不同值而有所不同。 如需詳細資訊，請參閱每個實體類型的項目。

輸入組合

調用

ActionEntityKind 列舉型別

ActionEntityKind 列舉會指定 Windows 上的應用程式動作所支援的實體類型。 在 JSON 動作定義中，實體類型是區分大小寫的字串常量。

實體屬性

每個實體類型都支援一或多個提供實體實例數據的屬性。 實體屬性名稱區分大小寫。

下列範例說明如何對於透過 URI 啟用的動作，在查詢字串中引用實體：

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

如需使用實體屬性在動作定義 JSON 中建立條件區段的資訊，請參閱 Where 子句。

檔案實體屬性

檔案實體屬性

Document 實體支援與 File 相同的屬性。

相片實體屬性

除了下列屬性之外， Photo 實體還支援 File 的所有屬性。

文字實體屬性

StreamingText 實體屬性

RemoteFile 實體屬性

RemoteFileKind 列舉

RemoteFileKind 列舉會指定 RemoteFile 實體支援的檔案類型。

表格實體屬性

連絡人實體屬性

Where 條件子句

動作定義 JSON 格式支援 where 子句，可用來實作條件邏輯，例如指定僅在實體屬性具有特定值時才應執行動作。

下列運算子可以搭配 where 子句使用。

Where 子句使用下列格式：

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

下列範例顯示 File 實體的副檔名為「.txt」時，where 子句評估結果為 true。

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

多個 where 子句可以使用邏輯 AND 和邏輯 OR 運算符結合。

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

相關文章