Personalizar manifesto do aplicativo

O manifesto do aplicativo (anteriormente chamado de manifesto de aplicativo do Teams) descreve como seu aplicativo se integra ao Teams. Após o scaffolding, o arquivo de manifesto do aplicativo padrão está disponível em appPackage/manifest.json. O arquivo de manifesto do aplicativo contém algumas variáveis de ambiente com formato de ${{XX_XX}}, e os valores reais são resolvidos usando o Teams Toolkit com arquivos de desenvolvimento como env/.env.dev e env/.env.local.

Para visualizar o manifesto do aplicativo com conteúdo real, o Teams Toolkit gera os arquivos de manifesto do aplicativo de visualização em appPackage/build pasta:

└───appPackage
    └───build
        ├───appPackage.{env}.zip - Zipped app package of remote Teams app
        ├───appPackage.local.zip - Zipped app package of local Teams app
        ├───manifest.{env}.json  - Previewed manifest of remote Teams app
        └───manifest.local.json  - Previewed manifest of local Teams app

Você pode visualizar o arquivo de manifesto do aplicativo no local e remover ambientes.

Visualizar o arquivo de manifesto do aplicativo no ambiente local

Para visualizar o arquivo de manifesto do aplicativo no ambiente local, pressione F5 para executar a depuração local. Depois de gerar as variáveis de ambiente no env/.env.local, o pacote de aplicativos e o manifesto do aplicativo de visualização são criados em appPackage/build pasta.

Você também pode disparar Zip Teams App Package do modo de exibição de árvore ou Teams: Zip Teams app Package da paleta de comandos para gerar o manifesto do aplicativo e o pacote de aplicativos visualizados.

Visualizar o arquivo de manifesto do aplicativo em ambiente remoto

Para visualizar o arquivo de manifesto do aplicativo em ambiente remoto, você pode disparar Provision do modo de exibição de árvore ou Teams: Provision in the cloud da paleta de comandos. Ele gera variáveis de ambiente para o aplicativo remoto do Teams, o pacote de aplicativos build e o manifesto do aplicativo de visualização em appPackage/build pasta.

Você também pode disparar o Pacote de Aplicativos zip teams do modo de exibição de árvore ou Teams: Zip Teams app Package da paleta de comandos para gerar o manifesto do aplicativo de visualização e o pacote de aplicativos.

Personalizar o manifesto do aplicativo para Visual Studio Code

Durante a depuração ou provisionamento local, o Teams Toolkit carrega o manifesto do aplicativo e resolve o manifesto do appPackage/manifest.json aplicativo por variáveis de ambiente definidas em env/.env.xx, em seguida, cria ou atualiza o aplicativo teams no Portal do Desenvolvedor do Teams.

1. Você pode definir seu próprio arquivo manifest.json em teamsapp.yml e teamsapp.local.yml. Por exemplo, você pode colocar o arquivo manifest.json no test/test.jsone atualizar os manifestPath parâmetros em arquivos yaml.

   - uses: teamsApp/zipAppPackage # Build Teams app package with latest env value
     with:
     manifestPath: ./test/test.json # Path to manifest template
     outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
     outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
   

2. Você pode definir suas próprias variáveis de ambiente. O manifesto.json padrão contém alguns espaços reservados com formato de ${{xx_xx}}. Você pode definir suas próprias variáveis de ambiente e adicionar espaços reservados no arquivo manifest.json. Por exemplo, você pode personalizar a descrição do aplicativo definindo uma nova variável de ambiente no arquivo env/.env.xx e atualizar manifest.json com espaço reservado correspondente.

   .env.dev

   TEAMS_APP_DESCRIPTION=This is an amazing app
   

   manifest.json

   {
       "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.16/MicrosoftTeams.schema.json",
       "manifestVersion": "1.16",
       "description": {
           "short": "${{TEAMS_APP_DESCRIPTION}}",
           "full": "Full description of tab0418"
       },
   }
   

Validar aplicativo

Após a personalização, você pode querer validar o manifesto do aplicativo ou o pacote de aplicativos. Você pode disparar Validate Application do modo de exibição de árvore ou Teams: ValidateApplication da paleta de comandos. Há duas opções ou Validate using manifest schemaValidate app package using validation rules.

Validar usando o esquema de manifesto do aplicativo

Essa opção renderiza appPackage/manifest.json com variáveis de ambiente e valida o manifesto do aplicativo com seu esquema.

Comando CLI:

teamsfx validate --manifest-path YOUR-PATH-TO-MANIFEST

Se você atender MissingEnvironmentVariablesError, significa que o Teams Toolkit não poderá encontrar variáveis de ambiente correspondentes definidas em manifest.json. Talvez seja necessário executar Provisionar ou F5 para gerar variáveis de ambiente ou atualizar .env.xx manualmente o arquivo para atender ao valor.

Validar o pacote de aplicativos usando regras de validação

Essa opção valida o pacote de aplicativos com zíper com regras de validação.

Comando CLI:

teamsfx validate --app-package-file-path YOUR-PATH-TO-APP-PACKAGE

Ele tem regras de validação adicionais do que o esquema de manifesto do aplicativo. Por exemplo, se a seção guia estática tiver entityId "conversas" e nome, o seguinte erro será exibido:

Atualizar o aplicativo teams

Depois de visualizar e validar o arquivo de manifesto do aplicativo, você pode sincronizar suas alterações locais com o Portal do Desenvolvedor do Teams disparando Teams: Update Teams app o comando da paleta de comandos:

Comando CLI:

teamsfx update teams-app

Observação

A alteração é refletida no Portal do Desenvolvedor. Todas as atualizações manuais no Portal do Desenvolvedor são substituídas.

Se o arquivo de manifesto do aplicativo estiver desatualizado devido à alteração do arquivo de configuração ou à alteração do modelo, selecione qualquer uma das seguintes ações:

• Somente visualização: o arquivo de manifesto do aplicativo local é substituído de acordo com a configuração atual.
• Versão prévia e atualização: o arquivo de manifesto do aplicativo local é substituído de acordo com a configuração atual e também atualizado para a plataforma do Teams.
• Cancelar: nenhuma ação é tomada.

Para visualizar valores para o ambiente local e de desenvolvimento

No appPackage/manifest.json, você pode ir ao CodeLens para visualizar os valores para local e dev ambiente.

Observação

Provisione o ambiente ou execute a depuração local para gerar variáveis de ambiente.

Você pode ir para .env o arquivo selecionando o CodeLens, que fornece uma lista suspensa com todos os nomes de ambiente. Depois de selecionar um ambiente, o arquivo correspondente .env será aberto.

Para visualizar valores para todo o ambiente, você pode passar o mouse sobre o espaço reservado. Ele mostra uma lista de nomes de ambiente e valores correspondentes. Se você não provisionou o ambiente ou executou a depuração local, a variável de ambiente poderá não existir. Selecione Trigger Teams: Provision in the cloud command to see placeholder value ou Trigger local debug to see placeholder value.

Confira também

• Visão geral do Kit de Ferramentas do Teams.
• Esquema de manifesto do aplicativo
• Portal do Desenvolvedor do Teams
• Gerenciar vários ambientes
• Pré-visualização pública do desenvolvedor para o Microsoft Teams
• Provisionar recursos de nuvem usando Visual Studio Code

Importante

Introduzimos a extensão do Teams Toolkit v5 em Visual Studio Code. Essa versão chega a você com muitos novos recursos de desenvolvimento de aplicativos. Recomendamos que você use o Teams Toolkit v5 para criar seu aplicativo teams.

Em breve, a extensão do Teams Toolkit v4 será preterida.

Personalizar o manifesto do aplicativo para Visual Studio Code

O manifesto do aplicativo (anteriormente chamado de manifesto de aplicativo do Teams) descreve como seu aplicativo se integra ao Teams. O arquivo manifest.template.json de modelo de manifesto do aplicativo está disponível em templates/appPackage pasta após o scaffolding. O arquivo de modelo com espaços reservados e os valores reais são resolvidos pelo Teams Toolkit usando arquivos em .fx/configs e .fx/states para diferentes ambientes.

Para visualizar o manifesto do aplicativo com conteúdo real, o Teams Toolkit gera os arquivos de manifesto do aplicativo de visualização em build/appPackage pasta:

└───build
    └───appPackage
        ├───appPackage.{env}.zip - Zipped app package of remote Teams app
        ├───appPackage.local.zip - Zipped app package of local Teams app
        ├───manifest.{env}.json  - Previewed manifest of remote Teams app
        └───manifest.local.json  - Previewed manifest of local Teams app

Você pode visualizar o arquivo de manifesto do aplicativo em ambientes locais e remotos.

Visualizar o arquivo de manifesto do aplicativo no ambiente local

Para visualizar o arquivo de manifesto do aplicativo no ambiente local, pressione F5 para executar a depuração local. Depois de gerar configurações locais padrão, o pacote de aplicativos e o manifesto do aplicativo de visualização são compilados em build/appPackage pasta.

Você pode visualizar o arquivo de manifesto do aplicativo local por dois métodos:

• Use a opção de visualização no CodeLens.
• Use a opção pacote de metadados do Zip Teams .

As etapas a seguir ajudam a visualizar o arquivo de manifesto do aplicativo local usando a opção de visualização no CodeLens:

1. Selecione Visualizar no CodeLens do manifest.template.json arquivo.

   

2. Selecione local.

   

Para visualizar o arquivo de manifesto do aplicativo local usando a opção pacote de metadados do Zip Teams :

1. Selecione manifest.template.json arquivo.

   

2. Selecione o ícone Kit de Ferramentas do Teams na Barra de Atividades Visual Studio Code.

3. Selecione Pacote de metadados do Zip Teams em DEPLOYMENT.

   

4. Selecione local.

   

A seguir está uma imagem local de visualização:

Visualizar o arquivo de manifesto do aplicativo em ambiente remoto

Para visualizar o arquivo de manifesto do aplicativo usando Visual Studio Code:

• Selecione Provisionar na nuvem emDEPLOYMENT no Teams Toolkit.

  

• Para visualizar o arquivo de manifesto do aplicativo usando a paleta de comandos. Você pode disparar o Teams: provisionar na nuvem a partir da paleta de comandos.

  

Ele gera configuração para o aplicativo remoto do Teams, cria o pacote e visualiza o manifesto do aplicativo em build/appPackage pasta.

Você pode visualizar o arquivo de manifesto do aplicativo em ambiente remoto por dois métodos:

• Use a opção de visualização no CodeLens.
• Use a opção pacote de metadados do Zip Teams .

Para visualizar o arquivo de manifesto do aplicativo usando a opção de visualização no CodeLens:

1. Selecione Visualizar no CodeLens do manifest.template.json arquivo.

   

2. Selecione seu ambiente.

   

   Observação

   Se houver mais de um ambiente, você precisará selecionar o ambiente que deseja visualizar.

Para visualizar o arquivo de manifesto do aplicativo selecionando o pacote de metadados do Zip Teams em ambiente remoto:

1. Selecione manifest.template.json arquivo.

   

2. Selecione o ícone Kit de Ferramentas do Teams na Barra de Atividades do Visual Studio Code.

3. Selecione Pacote de metadados do Zip Teams em DEPLOYMENT.

   

4. Selecione seu ambiente.

   

   Observação

   Se houver mais de um ambiente, você precisará selecionar o ambiente que deseja visualizar.

Sincronizar alterações locais no Portal do Desenvolvedor

Depois de visualizar o arquivo de manifesto do aplicativo, você pode sincronizar suas alterações locais com o Portal do Desenvolvedor pelas seguintes maneiras:

1. Implantar manifesto do aplicativo.

   Você pode implantar o manifesto do aplicativo de qualquer uma das seguintes maneiras:

   • Clique com o botão direito do mouse no manifest.template.json arquivo e selecione Implantar manifesto do aplicativo Teams no menu de contexto.

     

   • Disparar equipes: implante o manifesto do aplicativo Teams selecionando-o na paleta de comandos.

     

2. Atualizar para a plataforma do Teams.

   Você pode atualizar para a plataforma do Teams de qualquer uma das seguintes maneiras:

   • Selecione Atualizar para a plataforma do Teams no canto superior esquerdo do manifest.{env}.json.

   • Trigger Teams: atualizar manifesto para a plataforma do Teams na barra de menus de manifest.{env}.json. A imagem a seguir mostra o ambiente de desenvolvimento:

     

Você também pode disparar o Teams: atualizar o manifesto para a plataforma do Teams na paleta de comandos:

Observação

• O Gatilho do editor CodeLens ou a barra de menus atualiza o arquivo de manifesto do aplicativo atual para a plataforma teams.
• O Gatilho da paleta de comandos requer a seleção do ambiente de destino.

Comando CLI:

        teamsfx deploy manifest --include-app-manifest yes

---

Observação

A alteração é refletida no Portal do Desenvolvedor. Todas as atualizações manuais no Portal do Desenvolvedor são substituídas.

Se o arquivo de manifesto do aplicativo estiver desatualizado devido à alteração do arquivo de configuração ou à alteração do modelo, selecione qualquer uma das seguintes ações:

• Somente visualização: o arquivo de manifesto do aplicativo local é substituído de acordo com a configuração atual.
• Versão prévia e atualização: o arquivo de manifesto do aplicativo local é substituído de acordo com a configuração atual e também atualizado para a plataforma do Teams.
• Cancelar: nenhuma ação é tomada.

Personalizar o manifesto do aplicativo

O Teams Toolkit consiste nos seguintes arquivos de modelo de manifesto de aplicativo em manifest.template.json pasta em ambientes locais e remotos:

• manifest.template.json
• templates/appPackage

Durante a depuração ou provisionamento local, o Teams Toolkit carrega o arquivo de manifesto do aplicativo com as configurações de state.{env}.json, config.{env}.jsone cria o aplicativo Teams no Portal do manifest.template.json Desenvolvedor.

Espaços reservados com suporte em manifest.template.json

A lista a seguir fornece espaços reservados com suporte em manifest.template.json:

• {{state.xx}} é espaço reservado pré-definido e seu valor é resolvido pelo Kit de Ferramentas do Teams definido em state.{env}.json. Certifique-se de não modificar os valores em state.{env}.json.
• {{config.manifest.xx}} é um espaço reservado personalizado e seu valor é resolvido de config.{env}.json.

Para adicionar parâmetro personalizado

1. Adicione o parâmetro personalizado da seguinte maneira:
   a. Adicione um espaço reservado manifest.template.json com o padrão {{config.manifest.xx}}.
   B. Adicione um valor de configuração em config.{env}.json.

   {
       "manifest": {
        "KEY": "VALUE"
        }
   }
   

2. Você pode ir para o arquivo de configuração selecionando qualquer um dos espaços reservados de configuração Ir para o arquivo de configuração ou Exibir o arquivo de estado em manifest.template.json.

Validar manifesto do aplicativo

Durante operações como o pacote de metadados do Zip Teams, o Teams Toolkit valida o manifesto do aplicativo em relação ao esquema. A lista a seguir fornece diferentes maneiras de validar o manifesto do aplicativo:

• Em Visual Studio Code, acione o Teams: validar o arquivo de manifesto da paleta de comandos:

  

• Na CLI, use o comando:

     teamsfx validate --env local
     teamsfx validate --env dev
     ```
  
  

---

Para visualizar valores para o ambiente local e de desenvolvimento

No manifest.template.json, você pode ir ao CodeLens para visualizar os valores para local e dev ambiente.

Observação

Provisione o ambiente ou execute a depuração local para gerar valores para espaços reservados.

Você pode ir para o arquivo de estado ou arquivo de configuração selecionando o CodeLens, que fornece uma lista suspensa com todos os nomes de ambiente. Depois de selecionar um ambiente, o arquivo de estado ou arquivo de configuração correspondente é aberto.

Para visualizar valores para todos os ambientes, você pode passar o mouse sobre o espaço reservado. Ele mostra uma lista com nomes de ambiente e valores correspondentes. Se você não provisionou o ambiente ou executou a depuração local, selecione Trigger Teams: Provision in the cloud command to see placeholder value ou Trigger local debug to see placeholder value.

Confira também

• Visão geral do Kit de Ferramentas do Teams.
• Esquema de manifesto do aplicativo
• Portal do Desenvolvedor do Teams
• Ambientes no Teams Toolkit
• Pré-visualização pública do desenvolvedor para o Microsoft Teams
• Provisionar recursos de nuvem usando Visual Studio Code