Office.NotificationMessageAction interface

Pacote:

outlook

A definição da ação para uma mensagem de notificação.

Comentários

[ Conjunto de API: Caixa de correio 1.10 ]

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

Modo outlook aplicável: compor ou ler

Importante: no Outlook na Web moderno, o NotificationMessageAction objeto está disponível somente no modo Compose.

Exemplos

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

// Adds an informational message with actions to the mail item.
const id = $("#notificationId").val().toString();

const itemId = Office.context.mailbox.item.itemId;
const details = {
  type: Office.MailboxEnums.ItemNotificationMessageType.InsightMessage,
  message: "This is an insight notification with id = " + id,
  icon: "icon1",
  actions: [
    {
      actionText: "Open insight",
      actionType: Office.MailboxEnums.ActionType.ShowTaskPane,
      // Identify whether the current mail item is in read or compose mode to set the appropriate commandId value.
      commandId: (itemId == undefined ? "PG.HelpCommand.Compose" : "PG.HelpCommand.Read"),
      contextData: { a: "aValue", b: "bValue" }
    }
  ]
};

Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

Propriedades

actionText	O texto do link de ação.
actionType	O tipo de ação a ser executada. ActionType.ShowTaskPane é a única ação com suporte.
commandId	O botão definido no manifesto.
contextData	Todos os dados JSON que o botão de ação precisa passar para o suplemento.

Detalhes da propriedade

actionText

O texto do link de ação.

actionText: string;

Valor da propriedade

string

actionType

O tipo de ação a ser executada. ActionType.ShowTaskPane é a única ação com suporte.

actionType: string | MailboxEnums.ActionType;

Valor da propriedade

string | Office.MailboxEnums.ActionType

commandId

O botão definido no manifesto.

commandId: string;

Valor da propriedade

string

contextData

Todos os dados JSON que o botão de ação precisa passar para o suplemento.

contextData: any;

Valor da propriedade

any

Comentários

Importante:

• No Outlook no Windows, o any tipo tem suporte a partir da versão 2402 (Build 17308.20000). Em versões anteriores do Outlook no Windows, há suporte apenas para o string tipo.

• Para recuperar os dados JSON, chame Office.context.mailboxitem.getInitializationContextAsync. Se você criar uma cadeia de caracteres JSON usando JSON.stringify() e atribuí-la contextData à propriedade, você deverá analisar a cadeia de caracteres usando JSON.parse() depois de recuperá-la.