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: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante: no Outlook na Web moderno e no novo Outlook no Windows, o NotificationMessageAction objeto só está disponível 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 = (document.getElementById("notificationId") as HTMLInputElement).value;

const itemId = Office.context.mailbox.item.itemId;
const details = {
  type: Office.MailboxEnums.ItemNotificationMessageType.InsightMessage,
  message: "This is an insight notification with id = " + id,
  icon: "PG.Icon.16",
  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, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add insight notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added insight notification with id = ${id}.`);
});

Propriedades

actionText	O texto da ligação de ação.
actionType	O tipo de ação a executar. ActionType.ShowTaskPane é a única ação suportada.
commandId	O botão definido no manifesto.
contextData	Todos os dados JSON que o botão de ação tem de transmitir para o suplemento.

Detalhes da propriedade

actionText

O texto da ligação de ação.

actionText: string;

Valor da propriedade

string

actionType

O tipo de ação a executar. ActionType.ShowTaskPane é a única ação suportada.

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 tem de transmitir para o suplemento.

contextData: any;

Valor da propriedade

any

Comentários

Importante:

• No Outlook no Windows, o any tipo é suportado a partir da Versão 2402 (Compilação 17308.20000). Em versões anteriores do Outlook no Windows, apenas o string tipo é suportado.

• Para obter os dados JSON, chame Office.context.mailboxitem.getInitializationContextAsync. Se criar uma cadeia JSON com JSON.stringify() e atribuí-la à contextData propriedade, tem de analisar a cadeia com JSON.parse() uma vez obtê-la.

• Para impedir que o painel de tarefas de uma mensagem de notificação reinicie se já estiver aberto, implemente um processador para o Office.EventType.InitializationContextChanged evento. Em seguida, pode transmitir os argumentos do evento para a contextData propriedade .