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 do suplemento do Outlook da API JavaScript do Office inclui objetos, métodos, propriedades e eventos que você pode usar em um suplemento do Outlook.
Observação
Esta documentação destina-se a um conjunto de requisitos que não seja o mais recente.
Novidades da versão 1.5
O conjunto de requisitos de caixa de correio 1.5 inclui todos os recursos do conjunto de requisitos 1.4. Ele adicionou os seguintes recursos.
- Adicionado suporte para painéis de tarefas fixáveis.
- Adicionado suporte para chamar APIs REST.
Importante
Os pontos de extremidade REST v2.0 e beta do Outlook foram preteridos. Em vez disso, use a API REST do Microsoft Graph .
- Suporte adicionado para marcar um anexo como embutido.
- Adicionado suporte para fechar programaticamente um painel de tarefas ou caixa de diálogo.
- Adicionado suporte para a propriedade Office.context.diagnostics e seus objetos relacionados.
- Adicionado um evento para determinar quando um item de email do Outlook é selecionado para exibição enquanto o painel de tarefas do suplemento está fixado.
Lista de APIs
A tabela a seguir lista as APIs introduzidas no conjunto de requisitos de Caixa de Correio 1.5. Para exibir a documentação de referência de API para todas as APIs compatíveis com o conjunto de requisitos de Caixa de correio 1.5 ou anterior, consulte APIs do Outlook.
| Classe | Campos | Descrição |
|---|---|---|
| DragAndDropEventArgs | dragAndDropEventData | Obtém os detalhes sobre a posição do ponteiro do mouse no painel de tarefas de um suplemento e as mensagens ou anexos de arquivo que estão sendo arrastados e soltos no painel de tarefas. |
| tipo | Obtém o tipo do evento. | |
| DragoverEventData | pageX | Obtém a coordenada x do ponteiro do mouse que representa a posição horizontal, em pixels. |
| pageY | Obtém a coordenada y do ponteiro do mouse que representa a posição vertical, em pixels. | |
| taskPaneX | Obtém a coordenada x do ponteiro do mouse que representa a posição horizontal, em pixels. | |
| taskPaneY | Obtém a coordenada y do ponteiro do mouse que representa a posição vertical, em pixels. | |
| type | Obtém o tipo de evento arrastar e soltar. | |
| DropEventData | dataTransfer | Obtém as mensagens ou anexos de arquivo que estão sendo arrastados e soltos no painel de tarefas de um suplemento. |
| pageX | Obtém a coordenada x do ponteiro do mouse que representa a posição horizontal, em pixels. | |
| pageY | Obtém a coordenada y do ponteiro do mouse que representa a posição vertical, em pixels. | |
| taskPaneX | Obtém a coordenada x do ponteiro do mouse que representa a posição horizontal, em pixels. | |
| taskPaneY | Obtém a coordenada y do ponteiro do mouse que representa a posição vertical, em pixels. | |
| type | Obtém o tipo de evento arrastar e soltar. | |
| DroppedItemDetails | fileContent | Obtém o conteúdo do arquivo que está sendo arrastado e solto. |
| name | Obtém o nome do arquivo que está sendo arrastado e solto. | |
| type | Obtém o tipo do arquivo que está sendo arrastado e solto. | |
| DroppedItems | de arquivo | Obtém uma matriz de mensagens ou anexos de arquivo que estão sendo arrastados e soltos no painel de tarefas de um suplemento. |
| Caixa de Correio | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Adiciona um manipulador de eventos a um evento com suporte. |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Adiciona um manipulador de eventos a um evento com suporte. | |
| getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtém uma cadeia de caracteres que contém um token usado para chamar APIs REST ou Exchange Web Services (EWS). | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Remove um manipulador de eventos para um tipo de evento com suporte. | |
| removeHandlerAsync(eventType: Office.EventType | string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) | Remove um manipulador de eventos para um tipo de evento com suporte. | |
| restUrl | Obtém a URL do ponto de extremidade de REST para esta conta de email. |
Eventos
A tabela a seguir lista os eventos introduzidos no conjunto de requisitos 1.5. Para obter uma lista de todos os eventos com suporte que podem ser manipulados usando os addHandlerAsync métodos and removeHandlerAsync , confira Office.EventType.
| Evento | Descrição | Objeto |
|---|---|---|
| ItemChanged | Um item diferente do Outlook é selecionado para exibição enquanto o painel de tarefas do suplemento está fixado. | Mailbox |