Esquema JSON de definição de ação para Ações de Aplicativo 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 Build definida como "Conteúdo" e Copiar para 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 Formato XML do manifesto do pacote do provedor de ação.

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 um PWA (Aplicativo Web Progressivo). Para obter mais informações sobre ações de aplicativo com PWAs, consulte Habilitar Ações de Aplicativo no Windows para um PWA.

Raiz do documento

Ação

Saída

A versão do esquema e o suporte ao PWA variam para os diferentes valores da propriedade kind. Consulte a entrada de 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 com suporte das Ações de Aplicativo no Windows. No contexto de uma definição de ação JSON, os tipos de entidade são literais de cadeia de caracteres que diferenciam maiúsculas de minúsculas.

Propriedades da entidade

Cada tipo de entidade dá suporte a uma ou mais propriedades que fornecem dados de instância para a entidade. Os nomes de propriedade da entidade diferenciam 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 do 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 dá suporte às mesmas propriedades que o Arquivo.

Propriedades da entidade da foto

A entidade Photo dá suporte a todas as propriedades do Arquivo , além das propriedades a seguir.

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 de tabela

Propriedades de contato da entidade

Cláusulas Where

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

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

Onde as cláusulas usam 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 em que podem ser combinadas usando os operadores OR lógicos e AND lógicos.

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

Artigos relacionados