Office.MasterCategories interface
Representa la lista maestra de categorías en el buzón de correo.
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 principal de su buzón. Puede aplicar una o más categorías a un elemento.
Importante: En escenarios delegados o compartidos, el delegado puede obtener las categorías de la lista maestra, pero no puede agregar ni quitar categorías.
Comentarios
[ Conjunto de API: Buzón 1.8 ]
Nivel mínimo de permiso: buzón de lectura y escritura
Modo de Outlook aplicable: Redacción o lectura
Métodos
| add |
Agrega categorías a la lista maestra de un buzón. Cada categoría debe tener un nombre único, pero varias categorías pueden usar el mismo color. |
| add |
Agrega categorías a la lista maestra de un buzón. Cada categoría debe tener un nombre único, pero varias categorías pueden usar el mismo color. |
| get |
Obtiene la lista maestra de categorías de un buzón. |
| get |
Obtiene la lista maestra de categorías de un buzón. |
| remove |
Quita las categorías de la lista maestra de un buzón. |
| remove |
Quita las categorías de la lista maestra de un buzón. |
Detalles del método
addAsync(categories, options, callback)
Agrega categorías a la lista maestra de un buzón. Cada categoría debe tener un nombre único, pero varias categorías pueden usar el mismo color.
addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- categories
Categorías que se van a agregar a la lista maestra del buzó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.8 ]
Nivel mínimo de permiso: buzón de lectura y escritura
Modo de Outlook aplicable: Redacción o lectura
Errores:
DuplicateCategory: una de las categorías proporcionadas ya está en la lista de categorías maestras.PermissionDenied: el usuario no tiene permiso para realizar esta acción.
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-master-categories.yaml
const masterCategoriesToAdd = [
{
displayName: "TestCategory",
color: Office.MailboxEnums.CategoryColor.Preset0
}
];
Office.context.mailbox.masterCategories.addAsync(masterCategoriesToAdd, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Successfully added categories to master list");
} else {
console.log("masterCategories.addAsync call failed with error: " + asyncResult.error.message);
}
});
addAsync(categories, callback)
Agrega categorías a la lista maestra de un buzón. Cada categoría debe tener un nombre único, pero varias categorías pueden usar el mismo color.
addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- categories
Categorías que se van a agregar a la lista maestra del buzó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.8 ]
Nivel mínimo de permiso: buzón de lectura y escritura
Modo de Outlook aplicable: Redacción o lectura
Errores:
DuplicateCategory: una de las categorías proporcionadas ya está en la lista de categorías maestras.PermissionDenied: el usuario no tiene permiso para realizar esta acción.
getAsync(options, callback)
Obtiene la lista maestra de categorías de un buzón.
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 al agregar 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: buzón de lectura y escritura
Modo de Outlook aplicable: Redacción o lectura
getAsync(callback)
Obtiene la lista maestra de categorías de un buzón.
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.
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.8 ]
Nivel mínimo de permiso: buzón 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-master-categories.yaml
Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const categories = asyncResult.value;
if (categories && categories.length > 0) {
console.log("Master categories:");
console.log(JSON.stringify(categories));
} else {
console.log("There are no categories in the master list.");
}
} else {
console.error(asyncResult.error);
}
});
removeAsync(categories, options, callback)
Quita las categorías de la lista maestra de un buzón.
removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- categories
-
string[]
Categorías que se van a quitar de la lista maestra del buzón de correo.
- 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: buzón de lectura y escritura
Modo de Outlook aplicable: Redacción o lectura
Errores:
PermissionDenied: el usuario no tiene permiso para realizar esta acción.
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-master-categories.yaml
const masterCategoriesToRemove = ["TestCategory"];
Office.context.mailbox.masterCategories.removeAsync(masterCategoriesToRemove, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Successfully removed categories from master list");
} else {
console.log("masterCategories.removeAsync call failed with error: " + asyncResult.error.message);
}
});
removeAsync(categories, callback)
Quita las categorías de la lista maestra de un buzón.
removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- categories
-
string[]
Categorías que se van a quitar de la lista maestra del buzón de correo.
- 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: buzón de lectura y escritura
Modo de Outlook aplicable: Redacción o lectura
Errores:
PermissionDenied: el usuario no tiene permiso para realizar esta acción.
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de