APIs de suplemento do Outlook
Para usar APIs no seu suplemento do Outlook, você deve especificar o local da biblioteca Office.js, o conjunto de requisitos, o esquema e as permissões. Irá utilizar principalmente as APIs JavaScript do Office expostas através do objeto Caixa de Correio .
Biblioteca Office.js
Para interagir com a API de suplemento do Outlook, tem de utilizar as APIs javaScript no Office.js. A rede de entrega de conteúdos (CDN) da biblioteca é https://appsforoffice.microsoft.com/lib/1.1/hosted/Office.js. Suplementos enviados ao AppSource devem fazer referência ao Office.js por essa CDN. Eles não podem usar uma referência local.
Referência CDN em um <script> marca na <head> marca da página da web (arquivo. HTML,. aspx ou. PHP) implementa interface do usuário do seu suplemento.
<script src="https://appsforoffice.microsoft.com/lib/1.1/hosted/Office.js" type="text/javascript"></script>
À medida que adicionamos novas APIs, a URL para Office.js permanecerá a mesma. Somente mudaremos a versão na URL se mudarmos um comportamento de API existente.
Importante
Ao desenvolver um suplemento para qualquer aplicação cliente do Office, consulte a API JavaScript do Office a <head> partir da secção da página. Isso garante que a API seja totalmente inicializada antes de qualquer elemento de corpo.
Conjuntos de requisitos
Todas as APIs do Outlook pertencem ao conjunto de requisitos da Caixa de Correio. O conjunto de requisitos Mailbox tem versões, e cada novo conjunto de APIs lançado pertence a uma versão superior. Nem todos os clientes do Outlook terão suporte ao conjunto mais recente de APIs quando for lançado, mas se um cliente do Outlook declarar suporte a um conjunto de requisitos, ele dará suporte a todas as APIs nesse conjunto.
Especifique uma versão mínima de conjunto de requisitos no manifesto para controlar em quais clientes do Outlook o suplemento aparecerá. Por exemplo, se você especificar a versão 1.3 do conjunto de requisitos, o suplemento não aparecerá nos clientes do Outlook incompatíveis com a versão mínima 1.3.
A especificação de um conjunto de requisitos não limita seu suplemento às APIs nessa versão. Se o suplemento especificar a versão 1.1 do conjunto de requisitos, mas estiver sendo executado em um cliente do Outlook que dá suporte à versão 1.3, ele poderá usar as APIs v1.3. O conjunto de requisitos controla somente quais clientes do Outlook exibirão o suplemento.
Para verificar a disponibilidade das APIs de um conjunto de requisitos superior ao especificado no manifesto, use JavaScript padrão:
if (item.somePropertyOrFunction) {
item.somePropertyOrFunction...
}
Observação
essas verificações não são necessárias para APIs que estão na versão do conjunto de requisitos especificada no manifesto.
Especifique o conjunto de requisitos mínimo que proporciona suporte ao conjunto essencial de APIs para seu cenário, sem o qual os recursos do suplemento não funcionam. Especifique o requisito definido no manifesto. A marcação varia consoante o manifesto que estiver a utilizar.
- Manifesto apenas de suplemento: utilize o <elemento Requisitos> . Tenha em atenção que o <elemento subordinado Métodos> dos <Requisitos> não é suportado nos suplementos do Outlook, pelo que não pode declarar suporte para métodos específicos.
- Manifesto unificado para o Microsoft 365: utilize a propriedade "extensions.capabilities".
Para obter mais informações, veja Manifestos de suplementos do Office e Compreender os conjuntos de requisitos da API do Outlook.
Permissões
Seu suplemento requer as permissões apropriadas para usar as APIs de que precisa. Em geral, você deve especificar a permissão mínima necessária para o seu suplemento.
Existem quatro níveis de permissões; restrito, ler item, ler/escrever item e caixa de correio de leitura/escrita. Para obter mais detalhes. Para obter mais detalhes, confira Noções básicas sobre suplementos do Outlook.
Objeto Mailbox
Os suplementos do Outlook usam principalmente um subconjunto da API exposta no objeto Mailbox. Para aceder aos objetos e membros especificamente para utilização nos suplementos do Outlook, como o objeto Item , utilize a propriedade caixa de correio do objeto Contexto para aceder ao objeto Caixa de Correio , conforme mostrado na seguinte linha de código.
// Access the Item object.
const item = Office.context.mailbox.item;
Importante
Ao chamar Office.context.mailbox.item uma mensagem, tenha em atenção que o Painel de Leitura no cliente do Outlook tem de estar ativado. Para obter orientações sobre como configurar o Painel de Leitura, consulte Utilizar e configurar o Painel de Leitura para pré-visualizar mensagens.
Além disso, os suplementos do Outlook podem utilizar os seguintes objetos.
Objeto Office: para inicialização.
Objeto Context: para acesso a propriedades de conteúdo e idioma de exibição.
Para obter informações sobre como utilizar JavaScript em suplementos do Outlook, consulte Suplementos do Outlook. Para explorar a API JavaScript do Outlook, veja a página de referência da API do Outlook .