Adicione colaboração em tempo real com o Fluid Framework

Aplica-se a: Desenvolvedor

Use o Fluid Framework quando o aplicativo SharePoint Embedded precisar de estado compartilhado em tempo real, como controles colaborativos, contadores dinâmicos, cursores, anotações ou estado de formulário multiusuário. O Fluid fornece bibliotecas de clientes para distribuir, sincronizar e salvar dados compartilhados.

Preparar o SharePoint Embedded

Crie ou identifique um aplicativo Embedded do SharePoint antes de executar a amostra Fluid. Você precisa de credenciais de administrador para um locatário do Microsoft 365, a ID do cliente do aplicativo, a ID do tipo de contêiner e pelo menos um contêiner criado para esse tipo de contêiner.

Se você usou a extensão do Visual Studio Code Embedded do SharePoint, use a configuração de exemplo gerada para localizar ContainerTypeId e ClientId. Você também pode encontrar a ID do cliente no Microsoft Entra ID em Registros de aplicativo.

Para experimentar o SharePoint Embedded sem custo, crie um tipo de contêiner de avaliação. Consulte Criar e configurar um tipo de contêiner.

Executar a amostra do contador de itens

A item-counter-spe amostra reside no repositório Fluid Examples.

git clone https://github.com/microsoft/FluidExamples.git
cd FluidExamples\item-counter-spe

Crie um arquivo vazio .env na pasta de exemplo e adicione os identificadores incorporados do SharePoint.

SPE_CLIENT_ID=YOUR_CLIENTID
SPE_CONTAINER_TYPE_ID=YOUR_CONTAINERTYPE_ID
SPE_ENTRA_TENANT_ID=YOUR_ENTRA_TENANT_ID

Instale pacotes e inicie o servidor de desenvolvimento.

npm install
npm run dev

Após a conclusão do Webpack, abra http://localhost:8080, entre com credenciais de locatário e conceda consentimento de administrador para o aplicativo quando solicitado. Abra a mesma URL em outra guia do navegador ou envie-a para outro usuário no mesmo locatário. As alterações no contador de itens são sincronizadas entre os clientes conectados.

Se você não conseguir entrar no exemplo ou se ele exibir uma página em branco, consulte Solução de problemas para verificações de permissão de URI de redirecionamento e API.

Decidir o que pertence ao Fluido

Use o Fluid para o estado do aplicativo colaborativo que se beneficia da sincronização de baixa latência. Armazene documentos e arquivos duráveis em contêineres do SharePoint Embedded. Persista a saída final de negócios em seu próprio modelo durável ou em arquivos incorporados do SharePoint quando seu cenário precisar de auditoria, retenção, pesquisa ou relatório.

Trate os objetos compartilhados Fluid como um estado de colaboração visível para o usuário. Não coloque segredos, tokens de acesso, URLs SAS ou respostas privilegiadas do Graph em estruturas de dados compartilhadas.

Lidar com identidade e acesso

Seu aplicativo ainda precisa da ID do cliente incorporado do SharePoint e da ID do tipo de contêiner para adquirir os tokens corretos e acessar os contêineres. Teste o exemplo com uma guia, duas guias para o mesmo usuário e dois usuários diferentes do locatário. Verifique o comportamento dos usuários que podem exibir o contêiner, mas não devem editar o estado colaborativo.

Mover da amostra para o design do aplicativo

Use o exemplo de contador de itens para provar a configuração do locatário, o consentimento e a conectividade do cliente. Em seu próprio aplicativo, planeje o comportamento de reconexão, atualização de token, transições offline, alternância de contêiner e limpeza para sessões colaborativas que os usuários abandonarem.

Próximas etapas

• Configurar o SharePoint Embedded como uma fonte de conhecimento Foundry