Office.NotificationMessageAction interface

Paquete:

outlook

Definición de la acción de un mensaje de notificación.

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Importante: En la Outlook en la Web moderna y en la nueva Outlook en Windows, el NotificationMessageAction objeto solo está disponible en modo Compose.

Ejemplos

// 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}.`);
});

Propiedades

actionText	Texto del vínculo de acción.
actionType	Tipo de acción que se va a realizar. ActionType.ShowTaskPane es la única acción admitida.
commandId	Botón definido en el manifiesto.
contextData	Los datos JSON que el botón de acción debe pasar al complemento.

Detalles de las propiedades

actionText

Texto del vínculo de acción.

actionText: string;

Valor de propiedad

string

actionType

Tipo de acción que se va a realizar. ActionType.ShowTaskPane es la única acción admitida.

actionType: string | MailboxEnums.ActionType;

Valor de propiedad

string | Office.MailboxEnums.ActionType

commandId

Botón definido en el manifiesto.

commandId: string;

Valor de propiedad

string

contextData

Los datos JSON que el botón de acción debe pasar al complemento.

contextData: any;

Valor de propiedad

any

Comentarios

Importante:

• En Outlook en Windows, el tipo se admite a partir de la any versión 2402 (compilación 17308.20000). En versiones anteriores de Outlook en Windows, solo se admite el string tipo .

• Para recuperar los datos JSON, llame a Office.context.mailboxitem.getInitializationContextAsync. Si crea una cadena JSON mediante JSON.stringify() y la asigna a la contextData propiedad , debe analizar la cadena mediante JSON.parse() una vez que la recupere.

• Para evitar que el panel de tareas de un mensaje de notificación se vuelva a iniciar si ya está abierto, implemente un controlador para el Office.EventType.InitializationContextChanged evento. A continuación, puede pasar los argumentos del evento a la contextData propiedad .