Office.NotificationMessages interface

Paquete:: outlook

El objeto NotificationMessages se devuelve como la propiedad notificationMessages de un elemento.

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Importante: Para obtener información sobre los diferentes tipos de mensajes de notificación que puede implementar, consulte Creación de notificaciones para el complemento de Outlook.

Métodos

addAsync(key, JSONmessage, options, callback)	Agrega una notificación a un elemento.
addAsync(key, JSONmessage, callback)	Agrega una notificación a un elemento.
getAllAsync(options, callback)	Devuelve todas las claves y los mensajes de un elemento.
getAllAsync(callback)	Devuelve todas las claves y los mensajes de un elemento.
removeAsync(key, options, callback)	Quita un mensaje de notificación de un elemento.
removeAsync(key, callback)	Quita un mensaje de notificación de un elemento.
replaceAsync(key, JSONmessage, options, callback)	Reemplaza un mensaje de notificación que tiene una clave determinada con otro mensaje. Si no existe un mensaje de notificación con la clave especificada, `replaceAsync` agregará la notificación.
replaceAsync(key, JSONmessage, callback)	Reemplaza un mensaje de notificación que tiene una clave determinada con otro mensaje. Si no existe un mensaje de notificación con la clave especificada, `replaceAsync` agregará la notificación.

Detalles del método

addAsync(key, JSONmessage, options, callback)

Agrega una notificación a un elemento.

addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

key: string

Una clave especificada por el desarrollador que se usa para hacer referencia a este mensaje de notificación. Los desarrolladores pueden usarla para modificar este mensaje más tarde. No puede tener más de 32 caracteres.

JSONmessage: Office.NotificationMessageDetails

Un objeto JSON que contiene el mensaje de notificación que se va a agregar al elemento. Contiene un NotificationMessageDetails objeto .

options: Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Importante:

En Outlook en la Web, en Windows (nuevo y clásico) y en Mac, puede establecer un máximo de cinco notificaciones por mensaje. Si se establece más, se devuelve un NumberOfNotificationMessagesExceeded error. En Outlook en Android y en iOS, solo puede establecer una notificación por mensaje. Al establecer una notificación adicional, se reemplaza la anterior.
Solo se permite una notificación de tipo InsightMessage por complemento. Si se intenta agregar más, se producirá un error.
En la Outlook en la Web moderna y la nueva Outlook en Windows, puede agregar una InsightMessage notificación solo en Compose modo.
En Outlook en Android y en iOS, solo se admiten los ProgressIndicatortipos de notificación , InformationalMessagey ErrorMessage .
En el modo de redacción, mientras que el estilo de cada tipo de notificación varía en otros clientes de Outlook, las notificaciones en Outlook en Android y en iOS usan el mismo estilo. El mensaje de notificación siempre tiene el prefijo de un icono informativo.
El addAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

Ejemplos

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

// Adds a progress indicator to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add progress notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added progress notification with id = ${id}.`);
});

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added informational notification with id = ${id}.`);
});

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add persistent informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added persistent informational notification with id = ${id}.`);
});

...

// Adds an error notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "Error notification message with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add error notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added error notification with id = ${id}.`);
});

addAsync(key, JSONmessage, callback)

Agrega una notificación a un elemento.

addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

key: string

JSONmessage: Office.NotificationMessageDetails

Un objeto JSON que contiene el mensaje de notificación que se va a agregar al elemento. Contiene un NotificationMessageDetails objeto .

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Importante:

En Outlook en la Web, en Windows (nuevo y clásico) y en Mac, puede establecer un máximo de cinco notificaciones por mensaje. Si se establece más, se devuelve un NumberOfNotificationMessagesExceeded error. En Outlook en Android y en iOS, solo puede establecer una notificación por mensaje. Al establecer una notificación adicional, se reemplaza la anterior.
Solo se permite una notificación de tipo InsightMessage por complemento. Si se intenta agregar más, se producirá un error.
En la Outlook en la Web moderna y la nueva Outlook en Windows, puede agregar una InsightMessage notificación solo en Compose modo.
En Outlook en Android y en iOS, solo se admiten los ProgressIndicatortipos de notificación , InformationalMessagey ErrorMessage .
En el modo de redacción, mientras que el estilo de cada tipo de notificación varía en otros clientes de Outlook, las notificaciones en Outlook en Android y en iOS usan el mismo estilo. El mensaje de notificación siempre tiene el prefijo de un icono informativo.
El addAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

getAllAsync(options, callback)

Devuelve todas las claves y los mensajes de un elemento.

getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

Parámetros

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<Office.NotificationMessageDetails[]>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. La value propiedad del resultado es una matriz de NotificationMessageDetails objetos.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Ejemplos

// 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(JSON.stringify(asyncResult.value));
});

getAllAsync(callback)

Devuelve todas las claves y los mensajes de un elemento.

getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

Parámetros

callback: (asyncResult: Office.AsyncResult<Office.NotificationMessageDetails[]>) => void

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

removeAsync(key, options, callback)

Quita un mensaje de notificación de un elemento.

removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

key: string

La clave para que se quite el mensaje de notificación.

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Importante: El removeAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

Ejemplos

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

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to remove notification with id = ${id}. ${result.error.message}.`);
    return;
  }
  console.log(`Removed notification with id = ${id}.`);
});

removeAsync(key, callback)

Quita un mensaje de notificación de un elemento.

removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

key: string

La clave para que se quite el mensaje de notificación.

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

replaceAsync(key, JSONmessage, options, callback)

Reemplaza un mensaje de notificación que tiene una clave determinada con otro mensaje.

Si no existe un mensaje de notificación con la clave especificada, replaceAsync agregará la notificación.

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

key: string

La clave para que se reemplace el mensaje de notificación. No puede ser superior a 32 caracteres.

JSONmessage: Office.NotificationMessageDetails

Un objeto JSON que contiene el nuevo mensaje de notificación para reemplazar al mensaje existente. Contiene un NotificationMessageDetails objeto .

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Importante: El replaceAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

Ejemplos

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

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to replace notification with id = ${id}. ${result.error.message}.`);
      return;
    }
    console.log(`Replaced notification with id = ${id}.`);
  });

replaceAsync(key, JSONmessage, callback)

Reemplaza un mensaje de notificación que tiene una clave determinada con otro mensaje.

Si no existe un mensaje de notificación con la clave especificada, replaceAsync agregará la notificación.

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

key: string

La clave para que se reemplace el mensaje de notificación. No puede ser superior a 32 caracteres.

JSONmessage: Office.NotificationMessageDetails

Un objeto JSON que contiene el nuevo mensaje de notificación para reemplazar al mensaje existente. Contiene un NotificationMessageDetails objeto .

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

Office.NotificationMessages interface

Comentarios

Métodos

Detalles del método

addAsync(key, JSONmessage, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

addAsync(key, JSONmessage, callback)

Parámetros

Devoluciones

Comentarios

getAllAsync(options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

getAllAsync(callback)

Parámetros

Devoluciones

Comentarios

removeAsync(key, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

removeAsync(key, callback)

Parámetros

Devoluciones

Comentarios

replaceAsync(key, JSONmessage, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

replaceAsync(key, JSONmessage, callback)

Parámetros

Devoluciones

Comentarios

Comentarios