Office.Categories interface

  • Referencia
Paquete:
outlook

Representa las categorías de un elemento.

En Outlook, un usuario puede etiquetar mensajes y citas mediante una categoría para codificarlos a color. El usuario define categorías en una lista maestra en su buzón de correo. Puede aplicar una o más categorías a un elemento.

Importante: En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje en el modo Redactar.

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

Métodos

addAsync(categories, options, callback)

Agrega categorías a un elemento. Cada categoría debe estar en la lista maestra de categorías de ese buzón, por lo que debe tener un nombre único, pero varias categorías pueden usar el mismo color.

Importante: En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje o elemento de cita en el modo Redactar.
addAsync(categories, callback)

Agrega categorías a un elemento. Cada categoría debe estar en la lista maestra de categorías de ese buzón, por lo que debe tener un nombre único, pero varias categorías pueden usar el mismo color.

Importante: En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje o elemento de cita en el modo Redactar.
getAsync(options, callback)

Obtiene las categorías de un elemento.

Importante:

  • Si no hay ninguna categoría en el elemento, null o se devolverá una matriz vacía en función de la versión de Outlook, asegúrese de controlar ambos casos.

  • En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje en el modo Redactar.
getAsync(callback)

Obtiene las categorías de un elemento.

Importante:

  • Si no hay ninguna categoría en el elemento, null o se devolverá una matriz vacía en función de la versión de Outlook, asegúrese de controlar ambos casos.

  • En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje en el modo Redactar.
removeAsync(categories, options, callback)

Quita categorías de un elemento.

Importante: En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje en el modo Redactar.
removeAsync(categories, callback)

Quita categorías de un elemento.

Importante: En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje en el modo Redactar.

Detalles del método

addAsync(categories, options, callback)

Agrega categorías a un elemento. Cada categoría debe estar en la lista maestra de categorías de ese buzón, por lo que debe tener un nombre único, pero varias categorías pueden usar el mismo color.

Importante: En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje o elemento de cita en el modo Redactar.

addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

categories

string[]

Categorías que se van a agregar al elemento.

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.8 ]

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

Modo de Outlook aplicable: Redacción o lectura

Errores:

  • InvalidCategory: se proporcionaron categorías no válidas.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

addAsync(categories, callback)

Agrega categorías a un elemento. Cada categoría debe estar en la lista maestra de categorías de ese buzón, por lo que debe tener un nombre único, pero varias categorías pueden usar el mismo color.

Importante: En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje o elemento de cita en el modo Redactar.

addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

categories

string[]

Categorías que se van a agregar al elemento.

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.8 ]

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

Modo de Outlook aplicable: Redacción o lectura

Errores:

  • InvalidCategory: se proporcionaron categorías no válidas.

getAsync(options, callback)

Obtiene las categorías de un elemento.

Importante:

  • Si no hay ninguna categoría en el elemento, null o se devolverá una matriz vacía en función de la versión de Outlook, asegúrese de controlar ambos casos.

  • En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje en el modo Redactar.

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

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. Si se produce un error en la obtención de categorías, la asyncResult.error propiedad contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

getAsync(callback)

Obtiene las categorías de un elemento.

Importante:

  • Si no hay ninguna categoría en el elemento, null o se devolverá una matriz vacía en función de la versión de Outlook, asegúrese de controlar ambos casos.

  • En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje en el modo Redactar.

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

Parámetros

callback

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

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. Si se produce un error en la obtención de categorías, la asyncResult.error propiedad contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

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/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

removeAsync(categories, options, callback)

Quita categorías de un elemento.

Importante: En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje en el modo Redactar.

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

Parámetros

categories

string[]

Categorías que se van a quitar del elemento.

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. Si se produce un error al quitar categorías, la asyncResult.error propiedad contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

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

Modo de Outlook aplicable: Redacción o lectura

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

removeAsync(categories, callback)

Quita categorías de un elemento.

Importante: En Outlook en la Web, no puede usar la API para administrar las categorías aplicadas a un mensaje en el modo Redactar.

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

Parámetros

categories

string[]

Categorías que se van a quitar del elemento.

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. Si se produce un error al quitar categorías, la asyncResult.error propiedad contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

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

Modo de Outlook aplicable: Redacción o lectura