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.13
O conjunto de requisitos de caixa de correio 1.13 inclui todos os recursos do conjunto de requisitos 1.12. Ele adicionou os seguintes recursos.
- Adicionado suporte para ativar um suplemento sem o Painel de Leitura habilitado ou sem uma mensagem selecionada.
- Suporte adicional para gerenciar os dados de entrega e o horário de uma mensagem.
- Adicionados novos eventos para ativação baseada em eventos.
- Adicionado o recurso de seleção múltipla do item.
- Adicionado o recurso preceder ao enviar.
- Adicionado o recurso de rótulo de confidencialidade.
- Adicionado suporte para cenários de caixa de correio compartilhada.
Lista de APIs
A tabela a seguir lista as APIs introduzidas no conjunto de requisitos de Caixa de correio 1.13. 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.13 ou anterior, consulte APIs do Outlook.
| Classe | Campos | Descrição |
|---|---|---|
| AppointmentCompose | sensitivityLabel | Faz com que o objeto obtenha ou defina o rótulo de confidencialidade de um compromisso. |
| Body | prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Acrescenta HTML ou texto sem formatação ao início de uma mensagem ou corpo de compromisso quando o item de email é enviado. |
| prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Acrescenta HTML ou texto sem formatação ao início de uma mensagem ou corpo de compromisso quando o item de email é enviado. | |
| DelayDeliveryTime | getAsync(callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void) | Obtém a data e a hora de entrega de uma mensagem. |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void) | Obtém a data e a hora de entrega de uma mensagem. | |
| setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Define a data e a hora de entrega de uma mensagem. | |
| setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Define a data e a hora de entrega de uma mensagem. | |
| Caixa de Correio | getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<SelectedItemDetails[]>) => void) | Obtém as mensagens selecionadas no momento nas quais um suplemento pode ativar e executar operações. |
| getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SelectedItemDetails[]>) => void) | Obtém as mensagens selecionadas no momento nas quais um suplemento pode ativar e executar operações. | |
| MessageCompose | delayDeliveryTime | Obtém ou define a data e a hora atrasadas da entrega de uma mensagem. |
| sensitivityLabel | Faz com que o objeto obtenha ou defina o rótulo de confidencialidade de uma mensagem. | |
| SelectedItemDetails | itemId | O identificador de item do EWS (Exchange Web Services) da mensagem que está selecionada no momento. |
| itemMode | O modo Outlook (Read ou Compose) da mensagem que está selecionada no momento. |
|
| itemType | O tipo do item que está selecionado no momento. | |
| subject | A descrição que aparece no campo de assunto da mensagem que está selecionada no momento. | |
| SensitivityLabel | getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtém o identificador exclusivo (GUID) do rótulo de confidencialidade aplicado a uma mensagem ou compromisso que está sendo redigido. |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtém o identificador exclusivo (GUID) do rótulo de confidencialidade aplicado a uma mensagem ou compromisso que está sendo redigido. | |
| setAsync(sensitivityLabel: string | SensitivityLabelDetails, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) | Aplica o rótulo de confidencialidade especificado à mensagem ou ao compromisso que está sendo redigido. | |
| setAsync(sensitivityLabel: string | SensitivityLabelDetails, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) | Aplica o rótulo de confidencialidade especificado à mensagem ou ao compromisso que está sendo redigido. | |
| SensitivityLabelChangedEventArgs | type | O tipo de evento que foi gerado. |
| SensitivityLabelDetails | Crianças | Os sub-rótulos do rótulo de confidencialidade. |
| color | A cor do rótulo de confidencialidade. | |
| id | O identificador exclusivo (GUID) do rótulo de confidencialidade. | |
| name | O nome do rótulo de confidencialidade. | |
| Dica de ferramenta | A descrição do rótulo de confidencialidade. | |
| SensitivityLabelsCatalog | getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void) | Obtém todos os rótulos de confidencialidade habilitados no Outlook. |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void) | Obtém todos os rótulos de confidencialidade habilitados no Outlook. | |
| getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) | Verifica se o catálogo de rótulos de confidencialidade está habilitado no Outlook. | |
| getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) | Verifica se o catálogo de rótulos de confidencialidade está habilitado no Outlook. |
Eventos
A tabela a seguir lista os eventos introduzidos no conjunto de requisitos 1.13. 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 |
|---|---|---|
| SelectedItemsChanged | Uma ou mais mensagens são marcadas ou desmarcadas. | Mailbox |
| SensitivityLabelChanged | O rótulo de confidencialidade de uma mensagem ou compromisso é alterado. | Item |
Observação
Para eventos com suporte em um suplemento de ativação baseada em eventos, consulte Ativar suplementos com eventos.
Atualizações de manifesto
A tabela a seguir lista as atualizações de manifesto introduzidas no conjunto de requisitos de caixa de correio 1.13. Para saber mais sobre os tipos de manifestos de Suplementos do Office, consulte Manifesto de Suplementos do Office.
| Recurso | Manifesto unificado para o Microsoft 365 | Manifesto somente do suplemento | Descrição |
|---|---|---|---|
| Sem contexto de item | "extensions.runtimes.actions.supportsNoItemContext" |
SupportsNoItemContext | Permite que suplementos do painel de tarefas sejam ativados sem o Painel de Leitura habilitado ou uma mensagem selecionada. |
| Suporte à caixa de correio compartilhada |
"authorization.permissions.resourceSpecific.name" Defina como "Mailbox.SharedFolder" |
SupportsSharedFolders | Define se o suplemento está disponível em cenários de caixa de correio compartilhada. |
Confira também
Colaborar conosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde você também pode criar e revisar problemas e solicitações de pull. Para obter mais informações, confira o nosso guia para colaboradores.