Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
O subconjunto da API de suplemento do Outlook da API javaScript do Office inclui objetos, métodos, propriedades e eventos que pode utilizar num suplemento do Outlook.
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. Recomendamos que você experimente apenas em ambiente de teste e desenvolvimento. Não utilize APIs de pré-visualização num ambiente de produção ou em documentos críticos para a empresa.
Para usar APIs de visualização:
Tem de utilizar a versão de pré-visualização da biblioteca de API javaScript do Office a partir da rede de entrega de conteúdos (CDN)Office.js. O arquivo de definição de tipo da compilação TypeScript e IntelliSense pode ser encontrado na CDN e DefinitelyTyped. Pode instalar estes tipos com
npm install --save-dev @types/office-js-preview(certifique-se de que remove os tipos para@types/office-jsse os tiver instalado anteriormente).Poderá ter de aderir ao programa Microsoft 365 Insider para aceder a compilações mais recentes do Office no Outlook no Windows e no Mac.
Poderá ter de configurar a opção Lançamento direcionado no seu inquilino do Microsoft 365 para pré-visualizar funcionalidades no Outlook na Web. Para obter mais informações, consulte a secção "Lançamento direcionado" de Configurar as opções de lançamento Standard ou Direcionada.
O conjunto de requisitos de pré-visualização inclui todas as funcionalidades do conjunto de requisitos 1.15.
Importante
Esta documentação destina-se a um conjunto de requisitos de pré-visualização. Este conjunto de requisitos ainda não está totalmente implementado e os clientes não comunicarão com precisão o suporte para o mesmo. Não deve especificar este requisito definido no seu manifesto de suplemento.
Recursos no modo de visualização
Os seguintes recursos estão no modo de visualização.
- Suporte alargado para a
errorMessageMarkdownpropriedade doevent.completedmétodo para suplementos De Alertas Inteligentes no Outlook para Mac. - Foi adicionada uma propriedade para obter ou definir se um compromisso é um evento para todo o dia.
- Foram adicionados eventos para ativar um suplemento baseado em eventos numa mensagem no modo de leitura quando este contém determinados tipos de anexo ou cabeçalhos de Internet personalizados.
- Foi adicionada uma propriedade e objetos para definir temporariamente o corpo ou assunto apresentado no modo de leitura.
Lista de API
A tabela seguinte lista as APIs javaScript do Outlook atualmente em pré-visualização. Para ver a documentação de referência da API para todas as APIs JavaScript do Outlook (incluindo APIs de pré-visualização e APIs lançadas anteriormente), veja APIs do Outlook.
| Classe | Campos | Descrição |
|---|---|---|
| AppointmentCompose | isAllDayEvent | Obtém ou define a propriedade Office.IsAllDayEvent de um compromisso. |
| AppointmentRead | isAllDayEvent | Devolve um valor booleano que indica se o evento é todo o dia. |
| Display | body | Obtém um objeto para definir temporariamente o conteúdo apresentado no corpo de uma mensagem no modo de leitura. |
| subject | Obtém um objeto para definir temporariamente o conteúdo apresentado no assunto de uma mensagem no modo de leitura. | |
| DisplayedBody | setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Define temporariamente o conteúdo apresentado no corpo de uma mensagem no modo de leitura. |
| setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Define temporariamente o conteúdo apresentado no corpo de uma mensagem no modo de leitura. | |
| DisplayedSubject | setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Define temporariamente o conteúdo apresentado no assunto de uma mensagem no modo de leitura. |
| setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Define temporariamente o conteúdo apresentado no assunto de uma mensagem no modo de leitura. | |
| IsAllDayEvent | getAsync(chamada de retorno: (asyncResult: Office.AsyncResult<booleano>) => void) | Obtém o valor booleano que indica se o evento é o dia todo ou não. |
| getAsync(opções: Office.AsyncContextOptions, chamada de retorno: (asyncResult: Office.AsyncResult<booleano>) => void) | Obtém o valor booleano que indica se o evento é o dia todo ou não. | |
| setAsync(isAllDayEvent: booleano, chamada de retorno?: (asyncResult: Office.AsyncResult<void>) => void) | Define o evento para todo o dia status de um compromisso. | |
| setAsync(isAllDayEvent: booleano, opções: Office.AsyncContextOptions, chamada de retorno?: (asyncResult: Office.AsyncResult<void>) => void) | Define o evento para todo o dia status de um compromisso. | |
| MessageRead | apresentar | Obtém um objeto para definir temporariamente o conteúdo apresentado no corpo ou assunto de uma mensagem no modo de leitura. |