Windows 上的应用操作定义 JSON 架构

本文介绍 Windows 上应用操作的动作定义 JSON 文件格式。 该文件必须包含在生成操作设置为“内容”且复制到输出目录设置为“如果较新则复制”的项目中。 在包清单 XML 文件中指定 JSON 文件的包相对路径。 有关详细信息，请参阅操作提供程序包清单 XML 格式。

示例操作定义 JSON 文件

"version": 2, 
  "actions": [ 
    { 
      "id": "Contoso.SampleGreeting", 
      "description": "Send greeting with Contoso", 
      "icon": "ms-resource//...", 
      "usesGenerativeAI": false,
      "isAvailable": false,
      "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 文件的属性。

文档根目录

行动

输出

输入组合

调用

ActionEntityKind 枚举

ActionEntityKind 枚举指定 Windows 上的应用作支持的实体类型。 在 JSON 操作定义的上下文中，实体类型是区分大小写的字符串字面量。

实体属性

每个实体类型都支持一个或多个为实体提供实例数据的属性。 实体属性名称区分大小写。

以下示例说明了如何在通过 URI 激活启动的操作的查询字符串中引用实体：

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

有关使用实体属性在操作定义 JSON 中创建条件部分的信息，请参阅 Where 子语。

文件实体属性

文档实体属性

文档实体支持与文件相同的属性。

照片实体属性

除了以下属性外，照片 实体还支持文件的所有属性。

文本实体属性

StreamingText 实体属性

RemoteFile 实体属性

RemoteFileKind 枚举

RemoteFileKind 枚举指定 RemoteFile 实体支持的文件类型。

Where 子句

操作定义 JSON 格式支持可用于实现条件逻辑（例如指定仅当实体属性具有指定值时才应调用操作）的 where 子句。

以下运算符可与 where 子句一起使用。

Where 子句使用以下格式：

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

以下示例显示了一个 where 子句，如果文件实体具有文件扩展名“.txt”，则该子句的计算结果为 true。

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

可以使用逻辑 AND 和逻辑 OR 运算符组合多个 where 子句。

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

相关文章