Configurar Estrutura do SharePoint Web Parts no Microsoft Teams

Para acomodar as preferências dos usuários, você pode permitir que eles configurem suas Web Parts quando usadas no Microsoft Teams. Dependendo se você expôs suas Web Parts como guias do Teams ou aplicativos pessoais, há diferentes maneiras de implementar recursos de configuração em sua Web Part.

Dica

Para ver como usar os diferentes conceitos descritos neste artigo, consulte o aplicativo leads de exemplo no GitHub.

Configurar guias do Microsoft Teams criadas usando Estrutura do SharePoint

Normalmente, ao criar a guia Do Microsoft Teams, você precisa criar uma interface do usuário personalizada para permitir que os usuários configurem sua guia. Além disso, você precisa escrever código para armazenar e carregar valores de configuração conforme selecionado pelo usuário.

Ao criar guias usando Estrutura do SharePoint, a guia gerada usa o painel de propriedades da Web Part para permitir que os usuários configurem a guia. Isso economiza muito esforço. Não só você não precisa criar e manter uma interface do usuário de configuração separada, mas também não precisa implementar nenhum código responsável por armazenar e gerenciar as configurações. Tudo isso é tratado automaticamente para você por Estrutura do SharePoint.

Configurar aplicativos pessoais do Microsoft Teams criados usando Estrutura do SharePoint

Os aplicativos pessoais do Microsoft Teams não oferecem nenhuma infraestrutura para implementar a configuração. Em vez disso, seguindo o padrão recomendado pelo Microsoft Teams, as configurações do aplicativo pessoal devem ser expostas em uma guia separada.

Traduzir isso para sua solução do Estrutura do SharePoint significa criar uma Web Part separada que contém a interface do usuário de configuração e que será usada somente no contexto do aplicativo pessoal, definindo um armazenamento para a configuração do usuário e estendendo a definição de aplicativo pessoal para conter várias guias.

Web Part de interface do usuário de configuração de aplicativo pessoal

Cada guia em um aplicativo pessoal é mapeada para uma URL. A maneira mais fácil de criar a interface do usuário para configurar sua web part Estrutura do SharePoint exposta como um aplicativo pessoal é criando uma Web Part separada com a interface do usuário de configuração. Isso permitirá que você otimize a interface do usuário para uso no contexto do aplicativo pessoal e mantenha esse código separado da Web Part.

Como a Web Part da interface do usuário da configuração de aplicativo pessoal não deve ser usada fora do aplicativo pessoal, em seu manifesto, supportedHosts você deve definir a propriedade como uma matriz vazia.

O motivo pelo qual você supportedHosts deseja que a propriedade esteja vazia é impedir que a Web Part seja usada no SharePoint, mas também não incluí-la no manifesto do Teams gerado automaticamente. Por padrão, cada Web Part que TeamsTab contém o ou TeamsPersonalApp o valor no manifesto é incluída no manifesto do Teams gerado como um aplicativo separado do Microsoft Teams. Nesse caso, no entanto, você deseja que o aplicativo pessoal consista em várias guias, cada uma apontando para uma Web Part diferente. Isso só pode ser feito atualizando manualmente o manifesto por conta própria.

Para adicionar uma guia ao seu aplicativo pessoal e fazer com que ela aponte para outra Web Part, no manifesto do Teams definido no arquivo teams/manifest.json , staticTabs navegue até a seção e copie a entrada existente. Na entrada copiada, atualize os valores das propriedades entityId name . Na propriedade contentUrl , atualize o componentId valor do parâmetro de cadeia de caracteres de consulta para que ele corresponda à ID da Web Part de configurações, conforme definido em seu manifesto.

Escolha o local para armazenar a configuração do usuário

Por padrão, a configuração das Web Parts é compartilhada e a mesma para todos os usuários. No entanto, os aplicativos pessoais do Teams devem ser instalados, configurados e usados por indivíduos. Dessa forma, você precisa ter uma maneira de armazenar suas preferências.

Armazenar a configuração do usuário no Serviço de Perfil de Usuário

No passado, uma maneira comum de armazenar informações específicas do usuário no SharePoint era adicionar uma propriedade personalizada ao serviço de perfil de usuário e armazenar a configuração como uma cadeia de caracteres serializada. O problema com o uso do serviço de perfil de usuário para essa finalidade é que você não pode gerar automaticamente novas propriedades de perfil de usuário, o que complica a implantação do aplicativo.

Armazenar a configuração do usuário em uma lista personalizada

Como alternativa, você pode armazenar as configurações do usuário em uma lista. Você pode criar uma lista oculta no site raiz do SharePoint e configurá-la para que os usuários possam ver apenas seus itens. A desvantagem dessa abordagem é que sempre que sua Web Part é iniciada, você precisa verificar se a lista e as configurações do usuário atual existem e tratar normalmente erros caso não o faça. Além disso, ao carregar a interface do usuário de configuração, você precisaria verificar se a lista existe e provisioná-la, juntamente com todas as suas configurações, se necessário.

Armazenar a configuração do usuário na pasta pessoal do aplicativo

Uma das opções menos conhecidas para manter a configuração específica do aplicativo e do usuário é usar a pasta pessoal do aplicativo. A pasta específica do aplicativo está localizada no site de OneDrive for Business usuário. Cada aplicativo obtém uma pasta designada na qual pode armazenar qualquer número de arquivos.

Você pode pensar na pasta pessoal do aplicativo como uma pasta de configuração de um aplicativo da área de trabalho em seu disco, mas, em seguida, armazenada em OneDrive for Business e disponível em todos os dispositivos que você usa.

Dica

As pastas pessoais do aplicativo são criadas Azure AD aplicativo, portanto, no contexto do Estrutura do SharePoint, todas as soluções Estrutura do SharePoint compartilharão a pasta raiz do aplicativo. Para evitar colisões com outras soluções, você deve considerar a criação de uma subpasta para seu aplicativo.

Do ponto de vista técnico, a pasta pessoal do aplicativo é uma pasta em uma biblioteca de documentos do SharePoint e você pode armazenar qualquer número de arquivos e pastas dentro dele. Ao persistir a configuração do aplicativo na pasta pessoal do aplicativo, você serializaria suas configurações conforme definido pelo usuário e gravaria os dados serializados em um arquivo em sua pasta.

O conveniente sobre o uso da pasta pessoal do aplicativo é que ele é criado automaticamente se não existir, os dados de cada usuário são armazenados em seu próprio OneDrive for Business o que significa que outros usuários não podem ver ou adulterar suas configurações e não exige que você conheça urLs específicas, pois você pode acessar convenientemente usando o Microsoft Graph. Se algo der errado, o usuário poderá navegar até o site OneDrive for Business e excluir a configuração do aplicativo para redefinir seu estado.