Office.NotificationMessages interface

  • Referencia
Paquete:
outlook

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

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

Métodos

addAsync(key, JSONmessage, options, callback)

Agrega una notificación a un elemento.

Hay un máximo de 5 notificaciones por mensaje. Establecer más devolverá un error NumberOfNotificationMessagesExceeded.
addAsync(key, JSONmessage, callback)

Agrega una notificación a un elemento.

Hay un máximo de 5 notificaciones por mensaje. Establecer más devolverá un error NumberOfNotificationMessagesExceeded.
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.

Hay un máximo de 5 notificaciones por mensaje. Establecer más devolverá un error NumberOfNotificationMessagesExceeded.

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: Redacción o lectura

Importante:

  • Solo se permite una notificación de tipo InsightMessage por complemento. Si se intenta agregar más, se producirá un error.

  • En los Outlook en la Web modernos, solo puede agregar una InsightMessage notificación en el modo Redactar.

  • Solo se admite el InformationalMessage tipo en Outlook en Android y en iOS.

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 = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an error notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "Error notification message with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

addAsync(key, JSONmessage, callback)

Agrega una notificación a un elemento.

Hay un máximo de 5 notificaciones por mensaje. Establecer más devolverá un error NumberOfNotificationMessagesExceeded.

addAsync(key: string, JSONmessage: NotificationMessageDetails, 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 .

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: Redacción o lectura

Importante:

  • Solo se permite una notificación de tipo InsightMessage por complemento. Si se intenta agregar más, se producirá un error.

  • En los Outlook en la Web modernos, solo puede agregar una InsightMessage notificación en el modo Redactar.

  • Solo se admite el InformationalMessage tipo en Outlook en Android y en iOS.

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

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<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: Redacción 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(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

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: Redacción 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

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: Redacción o lectura

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 = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

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: Redacción 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

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: Redacción o lectura

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 = $("#notificationId").val().toString();
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
  },
  handleResult);

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: Redacción o lectura