Conjuntos de requisitos de API JavaScript do Outlook

Os suplementos do Outlook declaram as versões de API necessárias no respetivo manifesto. A marcação varia consoante esteja a utilizar o formato de manifesto apenas do suplemento ou o manifesto unificado para o Microsoft 365.

"extensions": [
{
  "requirements": {
    "capabilities": [
      {
        "name": "Mailbox", "minVersion": "1.1"
      }
    ]
  },
  ...
}

<Requirements>
  <Sets>
    <Set Name="Mailbox" MinVersion="1.1" />
  </Sets>
</Requirements>

Todas as APIs do Outlook pertencem ao Mailboxconjunto de requisitos. O conjunto de requisitos Mailbox tem versões, e cada novo conjunto de APIs que lançamos pertence a uma versão superior. Nem todos os clientes do Outlook suportam o conjunto de APIs mais recente, mas se um cliente do Outlook declarar suporte para um conjunto de requisitos, geralmente suporta todas as APIs nesse conjunto de requisitos (marcar a documentação sobre uma API ou funcionalidade específica para quaisquer exceções).

Definir uma versão mínima do conjunto de requisitos nos controlos de manifesto nos quais o suplemento será apresentado no cliente do Outlook. Se um cliente não suportar o conjunto de requisitos mínimo, não carrega o suplemento. Por exemplo, se for especificada a versão 1.3 do conjunto de requisitos, significa que o suplemento não aparecerá nos clientes do Outlook incompatíveis com a versão 1.3.

Utilizar APIs de conjuntos de requisitos posteriores

Definir um conjunto de requisitos não limita as APIs disponíveis que o suplemento pode utilizar. Por exemplo, se o suplemento especificar o conjunto de requisitos "Caixa de Correio 1.1", mas estiver a ser executado num cliente do Outlook que suporte "Caixa de Correio 1.3", o suplemento pode utilizar APIs do conjunto de requisitos "Caixa de Correio 1.3".

Para usar uma API mais recente, os desenvolvedores podem verificar se um determinado aplicativo oferece suporte ao conjunto de requisitos fazendo o seguinte:

if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
  // Perform actions.
}
else {
  // Provide alternate flow/logic.
}

Como alternativa, os desenvolvedores podem verificar a existência de uma API mais recente usando a técnica JavaScript padrão.

if (item.somePropertyOrMethod !== undefined) {
  // Use item.somePropertyOrMethod.
  item.somePropertyOrMethod;
}

Nenhuma verificação desse tipo é necessária para qualquer API que esteja presente na versão do conjunto de requisitos especificada no manifesto.

Escolher um conjunto de requisitos mínimo

Os desenvolvedores devem usar o conjunto de requisitos mínimos que contém o conjunto essencial de APIs para seu cenário, sem o qual o suplemento não funcionará.

Conjuntos de requisitos suportados pelos Exchange Servers e clientes do Outlook

Nesta seção, vemos a gama de conjuntos de requisitos com suporte do Exchange Server e clientes do Outlook. Para obter detalhes sobre os requisitos de cliente e servidor para executar suplementos do Outlook, confira requisitos dos suplementos do Outlook.

Suporte do Exchange Server

Os clientes a seguir oferecem suporte aos suplementos do Outlook.

Suporte a cliente Outlook

Os suplementos são compatíveis com o Outlook nas seguintes plataformas.

Suporte de versões para conjuntos de requisitos no Outlook clássico no Windows

A tabela seguinte lista o suporte de versões para conjuntos de requisitos de Caixa de Correio mais recentes no Outlook clássico no Windows com uma subscrição do Microsoft 365 ou uma licença perpétua de revenda.

Para obter mais detalhes sobre a sua versão de cliente, consulte a página do histórico de atualizações do Microsoft 365 ou Office 2024 e como localizar a sua versão de cliente do Office e atualizar o canal.

Referenciar a biblioteca de produção da API JavaScript do Office

Para usar APIs em qualquer um dos conjuntos de requisitos numerados, você deve fazer referência à biblioteca de produção na rede de distribuição de conteúdo (CDN) do Office.js. Para obter informações sobre como utilizar APIs de pré-visualização, veja Testar APIs de pré-visualização.

TESTAR APIs de pré-visualização

As novas APIs do JavaScript para Outlook são introduzidas pela primeira vez na "visualização" e, posteriormente, tornam-se parte de um conjunto específico de requisitos numerados, após passarem por vários testes e após a recolha das opiniões de usuários. Para fornecer feedback sobre uma API de visualização, use o mecanismo de feedback no final da página da Web em que a API está documentada.

Para saber mais detalhes sobre as APIs de visualização, confira o artigo sobre o conjunto de requisitos da API de visualização do Outlook.