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: item de leitura

Modo outlook aplicável: compor ou ler

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(asyncResult.value);
});

Propriedades

actions	Especifica ações para a mensagem. Limite: 1 ação. Esse limite não conta a ação "Descartar" incluída por padrão. Aplicável somente quando o tipo for InsightMessage. Especificar essa propriedade para um tipo sem suporte ou incluir muitas ações lança um erro. Importante: no Outlook na Web moderno, a actions propriedade está disponível somente no modo Compose.
icon	Uma referência a um ícone definido no manifesto. Ele aparece na área de barra de informações. Ele é aplicável se o tipo for InformationalMessage, e for necessário se o tipo for InsightMessage. Especificar esse parâmetro para um tipo incompatível resulta em uma exceção. Observação: no momento, o ícone personalizado é exibido apenas no Outlook no Windows e não em outros clientes (por exemplo, Mac, navegador da Web).
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 for InformationalMessage. Se for true, a mensagem permanecerá até ser removida por esse suplemento ou descartada pelo usuário. Se for falso, ele será removido quando o usuário navega 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. Se o tipo for ProgressIndicator ou ErrorMessage, um ícone será fornecido automaticamente e a mensagem não for persistente. O ícone e as propriedades persistentes, portanto, não são válidos para esses tipos de mensagens. Incluí-los resultará em um ArgumentException. Se o tipo for ProgressIndicator, o desenvolvedor deverá remover ou substituir o indicador de progresso quando a ação for concluída. Importante: só há suporte para o InformationalMessage tipo no Outlook no Android e no iOS.

Detalhes da propriedade

actions

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

Importante: no Outlook na Web moderno, a actions propriedade está disponível somente no modo Compose.

actions?: NotificationMessageAction[];

Valor da propriedade

Office.NotificationMessageAction[]

Comentários

[ Conjunto de API: Caixa de correio 1.10 ]

Modo outlook aplicável: compor ou ler

icon

Uma referência a um ícone definido no manifesto. Ele aparece na área de barra de informações. Ele é aplicável se o tipo for InformationalMessage, e for necessário se o tipo for InsightMessage. Especificar esse parâmetro para um tipo incompatível resulta em uma exceção.

Observação: no momento, o ícone personalizado é exibido apenas no Outlook no Windows e não em outros clientes (por exemplo, Mac, navegador da Web).

icon?: string;

Valor da propriedade

string

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 for InformationalMessage. Se for true, a mensagem permanecerá até ser removida por esse suplemento ou descartada pelo usuário. Se for falso, ele será removido quando o usuário navega 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.

Se o tipo for ProgressIndicator ou ErrorMessage, um ícone será fornecido automaticamente e a mensagem não for persistente. O ícone e as propriedades persistentes, portanto, não são válidos para esses tipos de mensagens. Incluí-los resultará em um ArgumentException.

Se o tipo for ProgressIndicator, o desenvolvedor deverá remover ou substituir o indicador de progresso quando a ação for concluída.

Importante: só há suporte para o InformationalMessage tipo no Outlook no Android e no iOS.

type: MailboxEnums.ItemNotificationMessageType | string;

Valor da propriedade

Office.MailboxEnums.ItemNotificationMessageType | string