Criar notificações para seu suplemento do Outlook

As mensagens de notificação permitem que o suplemento do Outlook exiba atualizações de status, erros e insights acionáveis diretamente em um item de email sem interromper o fluxo de trabalho do usuário. Há quatro tipos de notificação: ErrorMessage, InformationalMessage, InsightMessagee ProgressIndicator. Cada tipo serve a uma finalidade diferente e tem propriedades diferentes e plataformas com suporte.

Superfícies e modos do Outlook com suporte

As mensagens de notificação têm suporte em mensagens e compromissos nos modos de leitura e redação. Eles são exibidos acima do corpo do item de email.

Para gerenciar uma notificação em um item de email, chame notificationMessages (MessageRead, MessageCompose, AppointmentRead, AppointmentCompose) no código JavaScript do suplemento. Essa propriedade retorna um objeto NotificationMessages com métodos para adicionar, remover, obter ou substituir notificações. O código a seguir mostra como usar esses métodos para gerenciar as notificações do seu suplemento.

const notificationMessages = Office.context.mailbox.item.notificationMessages;

// Sample informational message.
const notificationDetails = {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "This is a sample notification message.",
    icon: "icon-16",
    persistent: false
};

const notificationKey = "notification_01";

// Add a notification to the mail item.
notificationMessages.addAsync(notificationKey, notificationDetails, (result) => {
    console.log("Added an informational notification.");
});

// Get all the notifications of the mail item.
notificationMessages.getAllAsync((result) => {
    console.log(JSON.stringify(result.value));
});

// Replace a notification.
const newNotification = {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "This is a sample error message."
};

notificationMessages.replaceAsync(notificationKey, newNotification, (result) => {
    console.log("Replaced the existing notification.");
});

// Remove a notification.
notificationMessages.removeAsync(notificationKey, (result) => {
    console.log("Removed the notification.");
});

Tipos de notificações

Uma notificação consiste em um identificador exclusivo, um ícone e uma mensagem. Dependendo do tipo, também pode incluir uma ação Ignorar ou uma ação personalizada. Há diferentes tipos de notificações que você pode exibir para o usuário para se adequar ao seu cenário específico.

• ErrorMessage
• InformationalMessage
• InsightMessage
• ProgressIndicator

A tabela a seguir resume as principais diferenças.

As seções a seguir descrevem cada tipo de notificação, incluindo suas propriedades e plataformas com suporte.

ErrorMessage

InformationalMessage

InsightMessage

ProgressIndicator

Comportamentos do recurso

Ao criar e gerenciar notificações para seu suplemento, lembre-se dos seguintes comportamentos, limitações e práticas recomendadas.

Número máximo de notificações por item de email

No Outlook na Web, no Windows (novo e clássico) e no Mac, você pode adicionar no máximo cinco notificações por mensagem. No Outlook em dispositivos móveis, apenas uma notificação pode ser adicionada a uma mensagem. A configuração de uma notificação adicional substitui a existente.

Limitações do InsightMessage

Somente uma InsightMessage notificação é permitida por suplemento em um item de email. No Outlook na Web e no novo Outlook no Windows, o InsightMessage tipo só tem suporte no modo de redação.

Ícones de notificação e manifesto unificado para o Microsoft 365

Se o seu suplemento usar o manifesto unificado para o Microsoft 365, você não poderá personalizar o ícone de uma InformationalMessage notificação ou InsightMessage . A notificação usa a primeira imagem especificada na matriz "icons" do primeiro objeto extensions.ribbons.tabs.groups.controls do manifesto. Embora esse seja o caso, você ainda deve especificar uma cadeia de caracteres na propriedade icon do objeto NotificationMessageDetails (por exemplo, "icon-16").

Ícones de notificação no Outlook para dispositivos móveis

No modo de redação, embora o estilo de cada tipo de notificação varie em outros clientes Outlook, as notificações no Outlook no Android e no iOS usam o mesmo estilo. A mensagem de notificação sempre usa um ícone de informações.

Notificações para várias mensagens selecionadas

Ao gerenciar notificações para várias mensagens selecionadas, apenas o getAllAsync método é suportado. Para saber mais, consulte Ativar seu suplemento do Outlook em várias mensagens.

Práticas recomendadas para notificações ProgressIndicator

Ao implementar uma ProgressIndicator notificação no suplemento, depois que a operação ou ação aplicável for concluída, substitua a notificação de progresso por outro tipo de notificação. Essa é uma prática recomendada para garantir que os usuários sempre obtenham o status mais recente de uma operação.

Experimente o exemplo de código no Script Lab

Saiba como usar as notificações em seu suplemento experimentando o exemplo Trabalhar com mensagens de notificação no Script Lab para Outlook. Para obter mais informações sobre o Script Lab, consulte Explorar a API JavaScript do Office usando o Script Lab.

Confira também

• Usar a API de diálogo do Office em suplementos do Office
• Ativar suplementos com eventos