Office.NotificationMessageAction interface
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 = $("#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);
Propiedades
action |
Texto del vínculo de acción. |
action |
Tipo de acción que se va a realizar.
|
command |
Botón definido en el manifiesto. |
context |
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 elstring
tipo .Para recuperar los datos JSON, llame a
Office.context.mailboxitem.getInitializationContextAsync
. Si crea una cadena JSON medianteJSON.stringify()
y la asigna a lacontextData
propiedad , debe analizar la cadena medianteJSON.parse()
una vez que la recupere.