Office.NotificationMessageDetails interface

Pacote:: outlook

Uma matriz de objetos NotificationMessageDetails é retornada pelo método NotificationMessages.getAllAsync.

Comentários

Nível mínimo de permissão: ler item

Modo do Outlook aplicável: Compose ou Ler

Importante: para saber mais sobre os diferentes tipos de mensagens de notificação que você pode implementar, confira Criar notificações para seu suplemento do Outlook.

Usada por

Office.NotificationMessages: addAsync, getAllAsync, replaceAsync

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }
  console.log(JSON.stringify(asyncResult.value));
});

Propriedades

actions	Especifica ações para a mensagem. Limite: 1 ação. Esse limite não conta a ação "Ignorar", que está incluída por padrão. Aplicável somente quando o tipo é `InsightMessage`. Especificar essa propriedade para um tipo sem suporte ou incluir muitas ações gera um erro. Importante: no Outlook na Web moderno e no novo Outlook no Windows, a `actions` propriedade está disponível apenas no modo Compose.
icon	Uma referência a um ícone personalizado definido no manifesto. O ícone aparece antes da mensagem de notificação na área da barra de informações. Um ícone deve ser especificado para `InformationalMessage` e `InsightMessage` notificações.
key	O identificador para a mensagem de notificação.
message	texto da mensagem de notificação. O tamanho máximo é de 150 caracteres. Se o desenvolvedor transmitir uma cadeia de caracteres maior, uma exceção `ArgumentOutOfRange` ocorrerá.
persistent	Especifica se a mensagem deve ser persistente. Aplicável somente quando o tipo é `InformationalMessage`. Se for verdadeira, a mensagem permanecerá até ser removida por esse suplemento ou ignorada pelo usuário. Se for false, ele será removido quando o usuário navegar para um item diferente. Para notificações de erro, a mensagem persiste até que o usuário a veja uma vez. Especificar esse parâmetro para um tipo incompatível gera uma exceção.
type	Especifica a `ItemNotificationMessageType` mensagem.

Detalhes da propriedade

actions

Especifica ações para a mensagem. Limite: 1 ação. Esse limite não conta a ação "Ignorar", que está incluída por padrão. Aplicável somente quando o tipo é InsightMessage. Especificar essa propriedade para um tipo sem suporte ou incluir muitas ações gera um erro.

Importante: no Outlook na Web moderno e no novo Outlook no Windows, a actions propriedade está disponível apenas no modo Compose.

actions?: NotificationMessageAction[];

Valor da propriedade

Office.NotificationMessageAction[]

Comentários

Conjunto de APIs: Caixa de Correio 1.10

Modo do Outlook aplicável: Compose ou Ler

icon

Uma referência a um ícone personalizado definido no manifesto. O ícone aparece antes da mensagem de notificação na área da barra de informações. Um ícone deve ser especificado para InformationalMessage e InsightMessage notificações.

icon?: string;

Valor da propriedade

string

Comentários

Importante:

Atualmente, o ícone personalizado só é exibido no Outlook clássico no Windows.
Um ícone personalizado só tem suporte em InformationalMessageInsightMessage e notificações. Especificar um ícone para outros tipos de notificação resulta em uma exceção.
Se o suplemento usar apenas o manifesto do suplemento, o ícone deverá ser especificado no elemento Images da seção Resources do manifesto.
Se o seu suplemento usa o manifesto unificado para o Microsoft 365, no momento, você não pode 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 icon propriedade (por exemplo, "ícone-16").

key

O identificador para a mensagem de notificação.

key?: string;

Valor da propriedade

string

message

texto da mensagem de notificação. O tamanho máximo é de 150 caracteres. Se o desenvolvedor transmitir uma cadeia de caracteres maior, uma exceção ArgumentOutOfRange ocorrerá.

message: string;

Valor da propriedade

string

persistent

Especifica se a mensagem deve ser persistente. Aplicável somente quando o tipo é InformationalMessage. Se for verdadeira, a mensagem permanecerá até ser removida por esse suplemento ou ignorada pelo usuário. Se for false, ele será removido quando o usuário navegar para um item diferente. Para notificações de erro, a mensagem persiste até que o usuário a veja uma vez. Especificar esse parâmetro para um tipo incompatível gera uma exceção.

persistent?: Boolean;

Valor da propriedade

Boolean

type

Especifica a ItemNotificationMessageType mensagem.

type: MailboxEnums.ItemNotificationMessageType | string;

Valor da propriedade

Office.MailboxEnums.ItemNotificationMessageType | string

Comentários

Importante:

Para os ProgressIndicator tipos ou ErrorMessage , um ícone é fornecido automaticamente e a mensagem não é persistente. Portanto, as propriedades icon e persistent não são válidas para esses tipos de mensagens. Incluí-los resultará em um ArgumentException.
Para o ProgressIndicator tipo, você deve remover ou substituir o indicador de progresso quando a ação for concluída.
No Outlook no Android e no iOS, há suporte apenas para os ProgressIndicatortipos , InformationalMessage, e ErrorMessage notificação.
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 prefixada com um ícone informativo.

Comentários

Esta página foi útil?