Office.SensitivityLabelsCatalog interface

Paquete:

outlook

Proporciona métodos para comprobar el estado del catálogo de etiquetas de confidencialidad en Outlook y recuperar todas las etiquetas de confidencialidad disponibles si el catálogo está habilitado.

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.

Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.

Métodos

getAsync(options, callback)	Obtiene todas las etiquetas de confidencialidad habilitadas en Outlook.
getAsync(callback)	Obtiene todas las etiquetas de confidencialidad habilitadas en Outlook.
getIsEnabledAsync(options, callback)	Comprueba si el catálogo de etiquetas de confidencialidad está habilitado en Outlook.
getIsEnabledAsync(callback)	Comprueba si el catálogo de etiquetas de confidencialidad está habilitado en Outlook.

Detalles del método

getAsync(options, callback)

Obtiene todas las etiquetas de confidencialidad habilitadas en Outlook.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => 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.SensitivityLabelDetails[]>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . Las etiquetas de confidencialidad disponibles y sus propiedades se devuelven en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.

Recomendado: para determinar si el catálogo de etiquetas de confidencialidad está habilitado en Outlook, llame a getIsEnabledAsync antes de usar getAsync.

Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.

getAsync(callback)

Obtiene todas las etiquetas de confidencialidad habilitadas en Outlook.

getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;

Parámetros

callback

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . Las etiquetas de confidencialidad disponibles y sus propiedades se devuelven en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.

Recomendado: para determinar si el catálogo de etiquetas de confidencialidad está habilitado en Outlook, llame a getIsEnabledAsync antes de usar getAsync.

Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-labels-catalog.yaml

// This snippet gets all available sensitivity labels from the catalog.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.sensitivityLabelsCatalog.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        const catalog = asyncResult.value;
        console.log("Sensitivity Labels Catalog:");
        console.log(JSON.stringify(catalog));
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

getIsEnabledAsync(options, callback)

Comprueba si el catálogo de etiquetas de confidencialidad está habilitado en Outlook.

getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => 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<boolean>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . El estado del catálogo de etiquetas de confidencialidad se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Importante: el administrador de una organización configura el catálogo de etiquetas de confidencialidad. Para obtener más información, consulte Introducción a las etiquetas de confidencialidad.

Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.

Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.

getIsEnabledAsync(callback)

Comprueba si el catálogo de etiquetas de confidencialidad está habilitado en Outlook.

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

Parámetros

callback

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . El estado del catálogo de etiquetas de confidencialidad se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Importante: el administrador de una organización configura el catálogo de etiquetas de confidencialidad. Para obtener más información, consulte Introducción a las etiquetas de confidencialidad.

Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.

Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-labels-catalog.yaml

// This snippet determines if the sensitivity labels catalog is enabled on the current mailbox.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(asyncResult.value);
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});