Conjunto de requisitos de API para suplementos do Outlook versão 1.3

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.3

O conjunto de requisitos de caixa de correio 1.3 inclui todos os recursos do conjunto de requisitos 1.2. Ele adicionou os seguintes recursos.

  • Adicionado suporte para comandos de função. Para obter mais informações, consulte Comandos de suplemento.

  • Adicionado um método para salvar um item sendo composto como um rascunho.

  • Adicionado um método para fechar um item que está sendo composto.

  • Adicionados métodos para obter ou definir todo o corpo de uma mensagem ou compromisso. Para obter mais informações, consulte Obter ou definir o corpo de uma mensagem ou compromisso no Outlook.

  • Métodos adicionados para converter IDs de item entre os formatos EWS e REST.

    Importante

    Os tokens de identidade de usuário e tokens de retorno de chamada herdados do Exchange Online não têm mais suporte e estão desativados em todos os locatários do Microsoft 365. Se um suplemento do Outlook exigir acesso de usuário delegado ou identidade de usuário, recomendamos o uso da MSAL (Biblioteca de Autenticação da Microsoft) e da autenticação de aplicativo aninhado (NAA). Os tokens de identidade do usuário do Exchange ainda têm suporte para o Exchange local.

  • Adicionada uma propriedade e métodos para adicionar, obter, substituir e remover mensagens de notificação de um item.

Lista de APIs

A tabela a seguir lista as APIs introduzidas no conjunto de requisitos de Caixa de correio 1.3. Para exibir a documentação de referência da API para todas as APIs compatíveis com o conjunto de requisitos de Caixa de correio 1.3 ou anterior, consulte APIs do Outlook.

Classe Campos Descrição
AppointmentCompose close() Fecha o item atual que está sendo composto.
notificationMessages Obtém as mensagens de notificação de um item.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Salva um item de forma assíncrona.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Salva um item de forma assíncrona.
AppointmentRead notificationMessages Obtém as mensagens de notificação de um item.
Body getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Retorna todo o corpo atual no formato especificado por coercionType.
getAsync(coercionType: Office.CoercionType | string, opções: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<string>) => void) Retorna todo o corpo atual no formato especificado por coercionType.
setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Substitui todo o corpo com o texto especificado.
setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<void>) => void) Substitui todo o corpo com o texto especificado.
Caixa de Correio convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion | string) Converte uma ID compatível no formato do Exchange Web Services (EWS).
convertToRestId(id: string, restVersion: MailboxEnums.RestVersion | string) Converte uma ID compatível em um formato REST.
MessageCompose close() Fecha o item atual que está sendo composto.
notificationMessages Obtém as mensagens de notificação de um item.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Salva de forma assíncrona a mensagem atual como um rascunho.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Salva de forma assíncrona a mensagem atual como um rascunho.
MessageRead notificationMessages Obtém as mensagens de notificação de um item.
NotificationMessageDetails icon Uma referência a um ícone personalizado definido no manifesto.
key O identificador para a mensagem de notificação.
message texto da mensagem de notificação.
persistente Especifica se a mensagem deve ser persistente.
type Especifica a ItemNotificationMessageType mensagem.
NotificationMessages addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona uma notificação a um item.
addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona uma notificação a um item.
getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) Retorna todas as chaves e mensagens de um item.
getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) Retorna todas as chaves e mensagens de um item.
removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Obtém uma mensagem de notificação de um item.
removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Obtém uma mensagem de notificação de um item.
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) Substitui uma mensagem de notificação que tenha uma determinada chave com outra mensagem.
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Substitui uma mensagem de notificação que tenha uma determinada chave com outra mensagem.
ItemNotificationMessageType ErrorMessage A mensagem de notificação é uma mensagem de erro.
InformationalMessage A mensagem de notificação é uma mensagem informativa.
ProgressIndicator A mensagem de notificação é um indicador de progresso.
RestVersion Beta Beta.
v1_0 Versão 1.0.
v2_0 Versão 2.0.

Confira também

  • Last updated on