Office.NotificationMessageDetails interface

Pacote:

outlook

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

Comentários

[ Conjunto de API: Caixa de Correio 1.3 ]

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

Modo Outlook aplicável: Compose ou Leitura

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

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. Este limite não conta a ação "Dispensar", que está incluída por predefinição. Aplicável apenas quando o tipo for InsightMessage. Especificar esta propriedade para um tipo não suportado ou incluir demasiadas ações gera um erro. Importante: no Outlook na Web moderno e no novo Outlook no Windows, a actions propriedade só está disponível no modo Compose.
icon	Uma referência a um ícone personalizado definido no manifesto. O ícone é apresentado antes da mensagem de notificação na área da barra de informações. Tem de ser especificado um ícone 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 apenas quando o tipo for InformationalMessage. Se for verdadeiro, a mensagem permanece até ser removida por este suplemento ou dispensada pelo utilizador. Se for falso, será removido quando o utilizador 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 o ItemNotificationMessageType da mensagem.

Detalhes da propriedade

actions

Especifica ações para a mensagem. Limite: 1 ação. Este limite não conta a ação "Dispensar", que está incluída por predefinição. Aplicável apenas quando o tipo for InsightMessage. Especificar esta propriedade para um tipo não suportado ou incluir demasiadas ações gera um erro.

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

actions?: NotificationMessageAction[];

Valor da propriedade

Office.NotificationMessageAction[]

Comentários

[ Conjunto de API: Caixa de Correio 1.10 ]

Modo Outlook aplicável: Compose ou Leitura

icon

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

icon?: string;

Valor da propriedade

string

Comentários

Importante:

• Atualmente, o ícone personalizado só é apresentado no Outlook clássico no Windows.

• Um ícone personalizado só é suportado em InformationalMessage notificações e InsightMessage . Especificar um ícone para outros tipos de notificação resulta numa exceção.

• Se o suplemento utilizar o manifesto apenas do suplemento, o ícone tem de ser especificado no elemento Imagens da secção Recursos do manifesto.

• Se o seu suplemento utilizar o manifesto unificado para o Microsoft 365, não pode personalizar o ícone de uma InformationalMessage notificação ou InsightMessage . A notificação utiliza a primeira imagem especificada na matriz "ícones" do primeiro objeto extensions.ribbons.tabs.groups.controls do manifesto. Embora seja este o caso, ainda tem de especificar uma cadeia 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 apenas quando o tipo for InformationalMessage. Se for verdadeiro, a mensagem permanece até ser removida por este suplemento ou dispensada pelo utilizador. Se for falso, será removido quando o utilizador 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 o ItemNotificationMessageType da 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. Por conseguinte, o ícone e as propriedades persistentes não são válidos para estes tipos de mensagens. Incluí-los resultará num ArgumentException.

• Para o ProgressIndicator tipo, deve remover ou substituir o indicador de progresso quando a ação estiver concluída.

• No Outlook para Android e no iOS, apenas são suportados os ProgressIndicatortipos de notificação , InformationalMessagee ErrorMessage .

• No modo de composição, enquanto o estilo de cada tipo de notificação varia em outros clientes do Outlook, as notificações no Outlook para Android e no iOS utilizam o mesmo estilo. A mensagem de notificação tem sempre um prefixo com um ícone informativo.