Office.NotificationMessageDetails interface

Paquete:

outlook

Una matriz de objetos NotificationMessageDetails que se devuelven mediante el método NotificationMessages.getAllAsync.

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

Propiedades

actions	Especifica las acciones para el mensaje. Límite: 1 acción. Este límite no cuenta la acción "Descartar" que se incluye de forma predeterminada. Solo se aplica cuando el tipo es InsightMessage. Si se especifica esta propiedad para un tipo no admitido o se incluyen demasiadas acciones, se produce un error. Importante: En la Outlook en la Web moderna y en la nueva Outlook en Windows, la actions propiedad solo está disponible en modo Compose.
icon	Referencia a un icono definido en el manifiesto. Aparece en el área de la barra de información. Es aplicable si el tipo es InformationalMessagey es necesario si el tipo es InsightMessage. Especificar este parámetro para un tipo no admitido produce una excepción. Nota: En la actualidad, el icono personalizado solo se muestra en Outlook en Windows y no en otros clientes (por ejemplo, Mac, explorador web).
key	El identificador para el mensaje de notificación.
message	El texto del mensaje de notificación. La longitud máxima es de 150 caracteres. Si el desarrollador pasa en una cadena más larga, se produce una excepción ArgumentOutOfRange.
persistent	Especifica si el mensaje debe ser persistente. Solo se aplica cuando el tipo es InformationalMessage. Si es true, el mensaje permanece hasta que este complemento lo quita o el usuario lo descarta. Si false, se quita cuando el usuario navega a otro elemento. Para las notificaciones de error, el mensaje persiste hasta que el usuario lo ve una vez. Si se especifica este parámetro para un tipo no admitido, se produce una excepción.
type	Especifica el ItemNotificationMessageType valor de de message. Si el tipo es ProgressIndicator o ErrorMessage, se proporciona automáticamente un icono y el mensaje no es persistente. Por lo tanto, el icono y las propiedades persistentes no son válidos para estos tipos de mensajes. Si se incluyen, se producirá un ArgumentException. Si el tipo es ProgressIndicator, el desarrollador debe quitar o reemplazar el indicador de progreso cuando se complete la acción. Importante: Solo el InformationalMessage tipo se admite en Outlook en Android y en iOS.

Detalles de las propiedades

actions

Especifica las acciones para el mensaje. Límite: 1 acción. Este límite no cuenta la acción "Descartar" que se incluye de forma predeterminada. Solo se aplica cuando el tipo es InsightMessage. Si se especifica esta propiedad para un tipo no admitido o se incluyen demasiadas acciones, se produce un error.

Importante: En la Outlook en la Web moderna y en la nueva Outlook en Windows, la actions propiedad solo está disponible en modo Compose.

actions?: NotificationMessageAction[];

Valor de propiedad

Office.NotificationMessageAction[]

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Modo de Outlook aplicable: Compose o lectura

icon

Referencia a un icono definido en el manifiesto. Aparece en el área de la barra de información. Es aplicable si el tipo es InformationalMessagey es necesario si el tipo es InsightMessage. Especificar este parámetro para un tipo no admitido produce una excepción.

Nota: En la actualidad, el icono personalizado solo se muestra en Outlook en Windows y no en otros clientes (por ejemplo, Mac, explorador web).

icon?: string;

Valor de propiedad

string

key

El identificador para el mensaje de notificación.

key?: string;

Valor de propiedad

string

message

El texto del mensaje de notificación. La longitud máxima es de 150 caracteres. Si el desarrollador pasa en una cadena más larga, se produce una excepción ArgumentOutOfRange.

message: string;

Valor de propiedad

string

persistent

Especifica si el mensaje debe ser persistente. Solo se aplica cuando el tipo es InformationalMessage. Si es true, el mensaje permanece hasta que este complemento lo quita o el usuario lo descarta. Si false, se quita cuando el usuario navega a otro elemento. Para las notificaciones de error, el mensaje persiste hasta que el usuario lo ve una vez. Si se especifica este parámetro para un tipo no admitido, se produce una excepción.

persistent?: Boolean;

Valor de propiedad

Boolean

type

Especifica el ItemNotificationMessageType valor de de message.

Si el tipo es ProgressIndicator o ErrorMessage, se proporciona automáticamente un icono y el mensaje no es persistente. Por lo tanto, el icono y las propiedades persistentes no son válidos para estos tipos de mensajes. Si se incluyen, se producirá un ArgumentException.

Si el tipo es ProgressIndicator, el desarrollador debe quitar o reemplazar el indicador de progreso cuando se complete la acción.

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

type: MailboxEnums.ItemNotificationMessageType | string;

Valor de propiedad

Office.MailboxEnums.ItemNotificationMessageType | string