Esquema JSON de definição de ação para ações de aplicativos no Windows

Este artigo descreve o formato do formato de arquivo JSON de definição de ação para Ações de Aplicativo no Windows. Esse arquivo deve ser incluído em seu projeto com a Ação de compilação definida como "Conteúdo" e Copiar para o diretório de saída definida como "Copiar se for mais recente". Especifique o caminho relativo ao pacote para o arquivo JSON no arquivo XML do manifesto do pacote. Para obter mais informações, consulte Manifesto de pacote XML do fornecedor de ações.

Exemplo de arquivo JSON de definição de ação

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

Propriedades JSON de definição de ação

As tabelas abaixo descrevem as propriedades do arquivo JSON de definição de ação.

O campo Versão indica a versão do esquema na qual a propriedade foi introduzida.

O campo PWA indica suporte para provedores de ação que são implementados como uma aplicação web progressiva (PWA). Para obter mais informações sobre ações de aplicativos com PWAs, consulte Habilitar ações de aplicativos no Windows para um PWA.

Raiz do documento

Ação

Resultado

A versão do esquema e o suporte ao PWA variam para os diferentes valores da propriedade kind . Consulte a entrada para cada tipo de entidade para obter detalhes.

Combinação de Entrada

Invocação

Enumeração ActionEntityKind

A enumeração ActionEntityKind especifica os tipos de entidades suportadas pelas Ações de Aplicativo no Windows. No contexto de uma definição de ação JSON, os tipos de entidade são literais de texto que são sensíveis a maiúsculas e minúsculas.

Propriedades da entidade

Cada tipo de entidade suporta uma ou mais propriedades que fornecem dados de instância para a entidade. Os nomes de propriedade da entidade diferençiam maiúsculas de minúsculas.

O exemplo a seguir ilustra como as entidades são referenciadas na cadeia de caracteres de consulta para ações que são iniciadas por meio da ativação de URI:

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

Para obter informações sobre como usar propriedades de entidade para criar seções condicionais na definição de ação JSON, consulte Cláusulas Where.

Propriedades da entidade de arquivo

Propriedades da entidade do documento

A entidade Document suporta as mesmas propriedades que File.

Propriedades da entidade fotográfica

A entidade Photo suporta todas as propriedades de File , além das seguintes propriedades.

Propriedades da entidade de texto

Propriedades da entidade StreamingText

Propriedades da entidade RemoteFile

Enumeração RemoteFileKind

A enumeração RemoteFileKind especifica os tipos de arquivos com suporte para a entidade RemoteFile .

Propriedades da entidade da tabela

Propriedades da entidade de contato

Cláusulas WHERE

O formato JSON de definição de ação suporta cláusulas where que podem ser usadas para implementar lógica condicional, como especificar que uma ação deve ser invocada somente quando uma propriedade de entidade tem um valor especificado.

Os operadores a seguir podem ser usados com cláusulas where .

Quando as cláusulas utilizam o seguinte formato:

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

O exemplo a seguir mostra uma cláusula where que é avaliada como true se uma entidade File tiver a extensão de arquivo ".txt".

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

Várias cláusulas WHERE podem ser combinadas usando os operadores lógicos E e OU.

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

Artigos relacionados