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.
A versão da API é especificada pela propriedade "extensions.requirements.capabilities". Defina a propriedade "capabilities.name" como "Caixa de Correio" e a propriedade "capabilities.minVersion" como o conjunto mínimo de requisitos de API que suporta os cenários do suplemento.
Por exemplo, o trecho de código de manifesto a seguir indica um conjunto mínimo de requisitos de 1.1.
"extensions": [
{
"requirements": {
"capabilities": [
{
"name": "Mailbox", "minVersion": "1.1"
}
]
},
...
}
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.
Observação
Embora o Outlook para Android e no iOS suporte até ao requisito definido como 1.5, o seu suplemento móvel pode agora implementar algumas APIs a partir de conjuntos de requisitos posteriores. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
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.
Importante
Se o servidor Exchange de destino e o cliente do Outlook suportarem conjuntos de requisitos diferentes, então você estará restrito ao intervalo de conjunto de requisitos mais baixo. Por exemplo, se um suplemento estiver a ser executado no Outlook 2019 no Windows (conjunto de requisitos mais elevado: 1.6) em relação ao Exchange 2016 (conjunto de requisitos mais elevado: 1,5), o seu suplemento poderá estar limitado ao requisito definido como 1,5.
Suporte do Exchange Server
Os clientes a seguir oferecem suporte aos suplementos do Outlook.
| Produto | Versão Principal do Exchange | Conjuntos de requisitos de API com suporte |
|---|---|---|
| Exchange Online | Versão mais recente |
1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14 IdentityAPI 1.31 |
| Exchange no local2 | 2019 | 1.1, 1.2, 1.3, 1.4, 1.5 |
| 2016 | 1.1, 1.2, 1.3, 1.4, 1.5 |
Observação
1 Para exigir a API de Identidade definida como 1.3 no seu código de suplemento do Outlook, marcar se for suportada ao chamar isSetSupported('IdentityAPI', '1.3'). Não é permitido declará-lo no manifesto do suplemento do Outlook. Você também pode determinar se a API tem suporte, verificando se ela não é undefined. Para mais detalhes, confira Usar APIs de conjuntos de requisitos posteriores.
2 Mesmo que um suplemento implemente funcionalidades de conjuntos de requisitos não suportados num ambiente do Exchange no local, ainda pode ser adicionado a um cliente do Outlook, desde que o conjunto de requisitos especificado no respetivo manifesto esteja alinhado com os suportados pelo Exchange no local. No entanto, uma funcionalidade implementada só funcionará se o cliente do Outlook no qual o suplemento está instalado suportar o requisito mínimo definido por uma funcionalidade. Para determinar os conjuntos de requisitos suportados por clientes do Outlook variados, consulte Suporte de cliente do Outlook. Recomendamos que o complemente com a documentação sobre a funcionalidade específica para quaisquer exceções.
Suporte a cliente Outlook
Os suplementos são compatíveis com o Outlook nas seguintes plataformas.
Observação
1 Os suplementos não são suportados no Outlook para Android, no iOS e na Web móvel moderna com contas do Exchange no local. Determinados dispositivos iOS ainda suportam suplementos ao utilizar contas do Exchange no local com Outlook na Web clássicos. Para obter informações sobre os dispositivos suportados, confira Requisitos para executar Suplementos do Office.
2 Os suplementos não funcionam em Outlook na Web modernos em smartphones iPhone e Android. Para obter informações sobre os dispositivos suportados, confira Requisitos para executar Suplementos do Office.
3 Para exigir a API de Identidade definida como 1.3 no seu código de suplemento do Outlook, marcar se for suportada ao chamar isSetSupported('IdentityAPI', '1.3'). Não é permitido declará-lo no manifesto do suplemento do Outlook. Você também pode determinar se a API tem suporte, verificando se ela não é undefined. Para mais detalhes, confira Usar APIs de conjuntos de requisitos posteriores.
4 Para saber mais sobre as versões mínimas suportadas para conjuntos de requisitos recentes no Outlook clássico no Windows com uma subscrição do Microsoft 365 ou uma licença perpétua de revenda, consulte Suporte de versões para conjuntos de requisitos no Outlook clássico no Windows.
5 O suporte para 1,4 em Outlook 2016 perpétuos licenciados em volume foi adicionado como parte da atualização de 3 de julho de 2018 para o Office 2016 (KB4022223).
6 O suporte para a nova IU do Mac está disponível na Versão 16.38.506 do Outlook. Para mais informações, consulte a seção Suporte de Suplemento no Outlook na nova Interface do Usuário do Mac.
7 Embora o Outlook clássico no Mac não suporte o requisito da Caixa de Correio definido como 1.9, suporta o conjunto de requisitos DialogApi 1.2. Para obter informações sobre a versão e compilação mínimas suportadas, veja Conjuntos de requisitos da API de Caixa de Diálogo.
8 Atualmente, existem considerações adicionais ao conceber e implementar suplementos para clientes móveis. Para obter mais detalhes, veja considerações de código ao adicionar suporte para comandos de suplementos no Outlook em dispositivos móveis. Embora o Outlook para Android e no iOS suporte até ao requisito definido como 1.5, o seu suplemento móvel pode agora implementar algumas APIs a partir de conjuntos de requisitos posteriores. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
Dica
É possível distinguir o Outlook clássico do moderno no navegador da Web, verificando sua barra de ferramentas da caixa de correio.
moderno
clássico
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.
| Conjunto de requisitos | Versão |
|---|---|
| 1,8 | Versão 1910 (Build 12130.20272) |
| 1.9 | Versão 2008 (Compilação 13127.20296) |
| 1.10 | Versão 2104 (Build 13929.20296) |
| 1.11 | Versão 2110 (build 14527.20226) |
| 1.12 | Versão 2206 (Build 15330.20196) |
| 1.13 | Versão 2304 (Compilação 16327.20248) |
| 11.4 | Versão 2404 (Compilação 17530.15000) |
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.
Observação
As APIs de pré-visualização estão sujeitas a alterações e não se destinam a ser utilizadas num ambiente de produção.
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.