Fazendo referência à biblioteca da API JavaScript do Office

  • Artigo

A biblioteca de API JavaScript do Office fornece as APIs que seu suplemento pode usar para interagir com o aplicativo do Office. A maneira mais simples de referenciar a biblioteca é usar a CDN (rede de entrega de conteúdo) adicionando a seguinte <script> marca na <head> seção de sua página HTML.

<head>
    ...
    <script src="https://appsforoffice.microsoft.com/lib/1/hosted/office.js" type="text/javascript"></script>
</head>

Isso baixará e armazenará em cache os arquivos da API JavaScript do Office na primeira vez que seu suplemento for carregado para garantir que ele esteja usando a implementação mais atualizada do Office.js e seus arquivos associados para a versão especificada.

Importante

Você deve fazer referência à API JavaScript do Office de dentro <head> da seção da página para garantir que a API seja totalmente inicializada antes de qualquer elemento do corpo.

Versões de API e compatibilidade com versões anteriores

No snippet HTML anterior, o /1/ na frente da URL da office.js CDN especifica a versão incremental mais recente na versão 1 do Office.js. Como a API JavaScript do Office mantém a compatibilidade atrasada, a versão mais recente continuará a dar suporte aos membros da API que foram introduzidos anteriormente na versão 1. Se você precisar atualizar um projeto existente, consulte Atualizar a versão da API JavaScript do Office e os arquivos de esquema de manifesto.

Se você planeja publicar seu Suplemento do Office do AppSource, deverá usar essa referência de CDN. As referências locais são adequadas somente para cenários internos, de depuração e de desenvolvimento.

Observação

Para usar APIs de visualização, faça referência à versão de visualização da biblioteca da API JavaScript do Office na CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Habilitando o IntelliSense para um projeto TypeScript

Além de fazer referência à API JavaScript do Office, conforme descrito anteriormente, você também pode habilitar o projeto de suplemento IntelliSense para TypeScript usando as definições de tipo do DefinitelyTyped. Para fazer isso, execute o comando a seguir em um prompt do sistema habilitado para nó (ou janela git bash) na raiz da pasta do projeto. Você deve ter o Node.js instalado (que inclui o npm).

npm install --save-dev @types/office-js

APIs de visualização

As novas APIs JavaScript são introduzidas pela primeira vez em "versão prévia" e, posteriormente, tornam-se parte de um conjunto de requisitos numerado específico depois que ocorrem testes suficientes e os comentários do usuário são adquiridos.

Observação

As APIs de visualização estão sujeitas a alterações e não se destinam ao uso em um ambiente de produção. Recomendamos que você experimente apenas em ambiente de teste e desenvolvimento. Não use APIs de visualização em um ambiente de produção ou em documentos essenciais aos negócios.

Para usar APIs de visualização:

Referências de CDN para outros ambientes do Microsoft 365

A 21Vianet opera e gerencia um serviço Office 365 alimentado por tecnologias licenciadas da Microsoft para fornecer serviços Office 365 para a China em conformidade com as leis e regulamentos locais. Os suplementos desenvolvidos para uso nesse ambiente de nuvem devem usar a CDN correspondente. Use https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.js em vez da referência de CDN padrão. Isso garante a conformidade contínua e fornece um melhor desempenho de suplemento.

Confira também