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: 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. 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 Compor.
icon	Uma referência a um ícone definido no manifesto. Ele aparece na área de barra de informações. É aplicável se o tipo for InformationalMessagee for necessário se o tipo for InsightMessage. Especificar esse parâmetro para um tipo incompatível resulta em uma exceção. Nota: neste momento, o ícone personalizado é apresentado apenas no Outlook no Windows e não noutros clientes (por exemplo, Mac, browser).
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. Se o tipo for ProgressIndicator ou ErrorMessage, um ícone é fornecido automaticamente e a mensagem não é persistente. O ícone e as propriedades persistentes, portanto, não são válidos para esses tipos de mensagens. Incluí-los resultará num ArgumentException. Se o tipo for ProgressIndicator, o programador deve remover ou substituir o indicador de progresso quando a ação estiver concluída. Importante: apenas o InformationalMessage tipo é suportado no Outlook para Android e no iOS.

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

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. É aplicável se o tipo for InformationalMessagee for necessário se o tipo for InsightMessage. Especificar esse parâmetro para um tipo incompatível resulta em uma exceção.

Nota: neste momento, o ícone personalizado é apresentado apenas no Outlook no Windows e não noutros clientes (por exemplo, Mac, browser).

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

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

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

Importante: apenas o InformationalMessage tipo é suportado no Outlook para Android e no iOS.

type: MailboxEnums.ItemNotificationMessageType | string;

Valor da propriedade

Office.MailboxEnums.ItemNotificationMessageType | string