O que é a biblioteca de cliente JavaScript do Teams?
A plataforma de desenvolvimento do Teams oferece a biblioteca de cliente JavaScript do Teams como uma biblioteca JavaScript para as suas aplicações cliente. A biblioteca é uma coleção de funções JavaScript através das quais pode utilizar a API do Teams para integrar funcionalidades e capacidades nas suas aplicações do Teams. As funcionalidades e capacidades são apresentadas como nativas do cliente do Teams. A biblioteca garante que as aplicações que criar com ela têm uma experiência consistente e amigável para os utilizadores do Teams.
Nesta unidade, irá aprender a utilizar a biblioteca numa aplicação.
Colocar a biblioteca na sua aplicação
Vejamos as diferentes formas de instalar a biblioteca numa aplicação.
Pode instalar a versão LTS da biblioteca de cliente JavaScript do Teams com npm ou yarn.
Para instalar a biblioteca com o npm:
npm install --save @microsoft/teams-js
Para instalar a biblioteca com o yarn:
yarn add @microsoft/teams-js
Se criar aplicações Web sem utilizar um bundler, pode carregar a biblioteca diretamente a partir da rede de entrega de conteúdos. Adicione o seguinte fragmento de código à sua aplicação Web:
<script src="https://res.cdn.office.net/teams-js/2.7.1/js/MicrosoftTeams.min.js "></script>
Como utilizar a biblioteca
A biblioteca de cliente JavaScript do Teams tem APIs que estão logicamente agrupadas em capacidades. Estas capacidades são espaços de nomes dentro da biblioteca. A aplicação de espaço de nomes de nível superior contém todas as APIs necessárias para a utilização geral da aplicação.
Pode inicializar a biblioteca com app.Initialize(). Após a inicialização da biblioteca, pode começar a utilizar o espaço de nomes para aceder a todas as APIs e funcionalidades incluídas na biblioteca. Para obter as informações contextuais básicas da sua aplicação, faça uma chamada para app.getContext(). Para gerar e apresentar uma ligação copiável para as informações para o utilizador partilhar, chame pages.shareDeepLink().
Para obter as informações de contexto da aplicação, execute este código:
await app.initialize();
const context = await app.getContext();
Obter informações de contexto sobre o Microsoft Teams ajuda a sua aplicação Teams a proporcionar uma experiência melhor e mais personalizada para os utilizadores. Por exemplo, com as informações de contexto, a sua aplicação pode compreender o ambiente específico no qual está a ser executada, como no Teams ou num browser, equipa ou canal, ou até mesmo no utilizador com o qual a sua aplicação está a interagir. Estas informações são úteis para determinar como configurar e apresentar corretamente funcionalidades ou capacidades relevantes e personalizadas ao utilizador.
Recursos
As APIs no SDK são agrupadas logicamente e são denominadas capacidades. Exemplos de capacidades são chat, caixa de diálogo e autenticação. Cada capacidade tem os seus próprios espaços de nomes; por exemplo, chat, caixa de diálogo ou página.
Observação
A biblioteca de cliente JavaScript do Teams versão 2.0.0 e posterior permite que as aplicações do Teams executem noutras aplicações anfitriãs, como o Outlook e Office.com. Estas funcionalidades de extensibilidade estão atualmente em pré-visualização nestas aplicações.
Pense no Microsoft Teams como o anfitrião atual da sua aplicação. O anfitrião tem algumas capacidades que podem ser integradas na sua aplicação. Por exemplo, a sua aplicação pode iniciar uma nova conversa ao chamar a chat.openChat() função da capacidade de chat do Microsoft Teams. Esta ação abre uma nova conversa 1:1 com um utilizador.
Pode utilizar <the-capability>.isSupported() a função para cada capacidade para verificar se a capacidade é suportada pelo anfitrião. Por exemplo, antes de efetuar a chamada para chat.openChat(), poderá querer verificar se o chat é suportado na aplicação anfitriã onde a aplicação está em execução. Para verificar, chame a função chat.isSupported().
true Devolve se o chat for suportado e false se o chat não for suportado. Esta verificação permite que a sua aplicação execute apenas as capacidades suportadas nas aplicações anfitriãs, para que os utilizadores tenham uma experiência mais natural em cada anfitrião.