Office.Categories interface

Representa las categorías de un elemento.

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

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

Comentarios

Conjunto de API: Buzón 1.8

Nivel mínimo de permisos: Leer elemento

Modo de Outlook aplicable: Componer o leer

Usada por

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 y, por lo tanto, debe tener un nombre único, pero varias categorías pueden usar el mismo color.
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 y, por lo tanto, debe tener un nombre único, pero varias categorías pueden usar el mismo color.
getAsync(options, callback)	Obtiene las categorías de un artículo. Importante: Si no hay categorías en el elemento, se devolverá una matriz vacía según la versión de Outlook, `null` así que asegúrese de controlar ambos casos. En Outlook en la Web y en el nuevo Outlook en Windows, no puede usar la API para administrar categorías aplicadas a un mensaje en modo Compose.
getAsync(callback)	Obtiene las categorías de un artículo. Importante: Si no hay categorías en el elemento, se devolverá una matriz vacía según la versión de Outlook, `null` así que asegúrese de controlar ambos casos. En Outlook en la Web y en el nuevo Outlook en Windows, no puede usar la API para administrar categorías aplicadas a un mensaje en modo Compose.
removeAsync(categories, options, callback)	Quita las categorías de un elemento.
removeAsync(categories, callback)	Quita las categorías de un elemento.

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 y, por lo tanto, debe tener un nombre único, pero varias categorías pueden usar el mismo color.

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 artículo.

options: Office.AsyncContextOptions

Un literal de objeto que contiene una o más de las siguientes propiedades:- asyncContext: Los desarrolladores pueden proporcionar cualquier objeto al que deseen acceder en la función de devolución de llamada.

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

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

Devoluciones

void

Comentarios

Conjunto de API: Buzón 1.8

Nivel mínimo de permisos: elemento de lectura/escritura

Modo de Outlook aplicable: Componer o leer

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

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 y, por lo tanto, debe tener un nombre único, pero varias categorías pueden usar el mismo color.

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

Parámetros

categories: string[]

Categorías que se van a agregar al artículo.

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

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

Devoluciones

void

Comentarios

Conjunto de API: Buzón 1.8

Nivel mínimo de permisos: elemento de lectura/escritura

Modo de Outlook aplicable: Componer o leer

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

Errores:

InvalidCategory : Se proporcionaron categorías no válidas.

getAsync(options, callback)

Obtiene las categorías de un artículo.

Importante:

Si no hay categorías en el elemento, se devolverá una matriz vacía según la versión de Outlook, null así que asegúrese de controlar ambos casos.
En Outlook en la Web y en el nuevo Outlook en Windows, no puede usar la API para administrar categorías aplicadas a un mensaje en modo Compose.

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

Parámetros

options: Office.AsyncContextOptions

Un literal de objeto que contiene una o más de las siguientes propiedades:- asyncContext: Los desarrolladores pueden proporcionar cualquier objeto al que deseen acceder en la función de devolución de llamada.

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

Cuando se completa el método, la función pasada en el callback parámetro se llama con un solo parámetro de tipo Office.AsyncResult. Si se produce un error al obtener categorías, la propiedad contendrá un código de asyncResult.error error.

Devoluciones

void

Comentarios

Conjunto de API: Buzón 1.8

Nivel mínimo de permisos: Leer elemento

Modo de Outlook aplicable: Componer o leer

getAsync(callback)

Obtiene las categorías de un artículo.

Importante:

Si no hay categorías en el elemento, se devolverá una matriz vacía según la versión de Outlook, null así que asegúrese de controlar ambos casos.
En Outlook en la Web y en el nuevo Outlook en Windows, no puede usar la API para administrar categorías aplicadas a un mensaje en modo Compose.

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

Parámetros

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

Cuando se completa el método, la función pasada en el callback parámetro se llama con un solo parámetro de tipo Office.AsyncResult. Si se produce un error al obtener categorías, la propiedad contendrá un código de asyncResult.error error.

Devoluciones

void

Comentarios

Conjunto de API: Buzón 1.8

Nivel mínimo de permisos: Leer elemento

Modo de Outlook aplicable: Componer o leer

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 las categorías de un elemento.

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

Un literal de objeto que contiene una o más de las siguientes propiedades:- asyncContext: Los desarrolladores pueden proporcionar cualquier objeto al que deseen acceder en la función de devolución de llamada.

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

Opcional. Cuando se completa el método, la función pasada en el callback parámetro se llama con un solo parámetro de tipo Office.AsyncResult. Si se produce un error al quitar categorías, la propiedad contendrá un código de asyncResult.error error.

Devoluciones

void

Comentarios

Conjunto de API: Buzón 1.8

Nivel mínimo de permisos: elemento de lectura/escritura

Modo de Outlook aplicable: Componer o leer

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

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 las categorías de un elemento.

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, la función pasada en el callback parámetro se llama con un solo parámetro de tipo Office.AsyncResult. Si se produce un error al quitar categorías, la propiedad contendrá un código de asyncResult.error error.

Devoluciones

void

Comentarios

Conjunto de API: Buzón 1.8

Nivel mínimo de permisos: elemento de lectura/escritura

Modo de Outlook aplicable: Componer o leer

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

Comentarios

Usada por

Métodos

Detalles del método

addAsync(categories, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

addAsync(categories, callback)

Parámetros

Devoluciones

Comentarios

getAsync(options, callback)

Parámetros

Devoluciones

Comentarios

getAsync(callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

removeAsync(categories, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

removeAsync(categories, callback)

Parámetros

Devoluciones

Comentarios

Comentarios