Office.Categories interface
Representa as categorias em um item.
No Outlook, um usuário pode marcar mensagens e compromissos usando uma categoria para codificar as cores. O usuário define categorias em uma lista de master em sua caixa de correio. Ele pode, em seguida, aplicar uma ou mais categorias a um item.
Importante: em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a uma mensagem no modo Compose.
Comentários
[ Conjunto de API: Caixa de correio 1.8 ]
Nível mínimo de permissão: item de leitura
Modo outlook aplicável: compor ou ler
Métodos
add |
Adiciona categorias a um item. Cada categoria deve estar nas categorias master lista nessa caixa de correio e, portanto, deve ter um nome exclusivo, mas várias categorias podem usar a mesma cor. Importante: em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a um item de mensagem ou compromisso no modo Compose. |
add |
Adiciona categorias a um item. Cada categoria deve estar nas categorias master lista nessa caixa de correio e, portanto, deve ter um nome exclusivo, mas várias categorias podem usar a mesma cor. Importante: em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a um item de mensagem ou compromisso no modo Compose. |
get |
Obtém as categorias de um item. Importante:
|
get |
Obtém as categorias de um item. Importante:
|
remove |
Remove categorias de um item. Importante: em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a uma mensagem no modo Compose. |
remove |
Remove categorias de um item. Importante: em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a uma mensagem no modo Compose. |
Detalhes do método
addAsync(categories, options, callback)
Adiciona categorias a um item. Cada categoria deve estar nas categorias master lista nessa caixa de correio e, portanto, deve ter um nome exclusivo, mas várias categorias podem usar a mesma cor.
Importante: em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a um item de mensagem ou compromisso no modo Compose.
addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parâmetros
- categories
-
string[]
As categorias a serem adicionadas ao item.
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext
: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método é concluído, a função passada no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
.
Retornos
void
Comentários
[ Conjunto de API: Caixa de correio 1.8 ]
Nível mínimo de permissão: item de leitura/gravação
Modo outlook aplicável: compor ou ler
Erros:
InvalidCategory
: categorias inválidas foram fornecidas.
Exemplos
// 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)
Adiciona categorias a um item. Cada categoria deve estar nas categorias master lista nessa caixa de correio e, portanto, deve ter um nome exclusivo, mas várias categorias podem usar a mesma cor.
Importante: em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a um item de mensagem ou compromisso no modo Compose.
addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parâmetros
- categories
-
string[]
As categorias a serem adicionadas ao item.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método é concluído, a função passada no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
.
Retornos
void
Comentários
[ Conjunto de API: Caixa de correio 1.8 ]
Nível mínimo de permissão: item de leitura/gravação
Modo outlook aplicável: compor ou ler
Erros:
InvalidCategory
: categorias inválidas foram fornecidas.
getAsync(options, callback)
Obtém as categorias de um item.
Importante:
Se não houver categorias no item ou
null
uma matriz vazia será retornada dependendo da versão do Outlook, certifique-se de manipular ambos os casos.Em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a uma mensagem no modo Compose.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext
: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.
- callback
-
(asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void
Quando o método é concluído, a função passada no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Se as categorias de obtenção falharem, a asyncResult.error
propriedade conterá um código de erro.
Retornos
void
Comentários
[ Conjunto de API: Caixa de correio 1.8 ]
Nível mínimo de permissão: item de leitura
Modo outlook aplicável: compor ou ler
getAsync(callback)
Obtém as categorias de um item.
Importante:
Se não houver categorias no item ou
null
uma matriz vazia será retornada dependendo da versão do Outlook, certifique-se de manipular ambos os casos.Em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a uma mensagem no modo Compose.
getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void
Quando o método é concluído, a função passada no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Se as categorias de obtenção falharem, a asyncResult.error
propriedade conterá um código de erro.
Retornos
void
Comentários
[ Conjunto de API: Caixa de correio 1.8 ]
Nível mínimo de permissão: item de leitura
Modo outlook aplicável: compor ou ler
Exemplos
// 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)
Remove categorias de um item.
Importante: em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a uma mensagem no modo Compose.
removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parâmetros
- categories
-
string[]
As categorias a serem removidas do item.
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext
: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método é concluído, a função passada no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Se a remoção de categorias falhar, a asyncResult.error
propriedade conterá um código de erro.
Retornos
void
Comentários
[ Conjunto de API: Caixa de correio 1.8 ]
Nível mínimo de permissão: item de leitura/gravação
Modo outlook aplicável: compor ou ler
Exemplos
// 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)
Remove categorias de um item.
Importante: em Outlook na Web, você não pode usar a API para gerenciar categorias aplicadas a uma mensagem no modo Compose.
removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parâmetros
- categories
-
string[]
As categorias a serem removidas do item.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método é concluído, a função passada no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Se a remoção de categorias falhar, a asyncResult.error
propriedade conterá um código de erro.
Retornos
void
Comentários
[ Conjunto de API: Caixa de correio 1.8 ]
Nível mínimo de permissão: item de leitura/gravação
Modo outlook aplicável: compor ou ler
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de