Office.MasterCategories interface
Représente la liste principale des catégories sur la boîte aux lettres.
Dans Outlook, un utilisateur peut étiqueter des messages et des rendez-vous à l’aide d’une catégorie pour les coder par couleur. L’utilisateur définit les catégories dans une liste sur sa boîte aux lettres principale. Ils peuvent ensuite appliquer une ou plusieurs catégories à un élément.
Important : Dans les scénarios délégués ou partagés, le délégué peut obtenir les catégories dans la liste principale, mais ne peut pas ajouter ou supprimer des catégories.
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : boîte aux lettres en lecture/écriture
Mode Outlook applicable : Rédiger ou Lire
Méthodes
add |
Ajoute des catégories à la liste principale d’une boîte aux lettres. Chaque catégorie doit avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur. |
add |
Ajoute des catégories à la liste principale d’une boîte aux lettres. Chaque catégorie doit avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur. |
get |
Obtient la liste principale des catégories d’une boîte aux lettres. |
get |
Obtient la liste principale des catégories d’une boîte aux lettres. |
remove |
Supprime des catégories de la liste principale d’une boîte aux lettres. |
remove |
Supprime des catégories de la liste principale d’une boîte aux lettres. |
Détails de la méthode
addAsync(categories, options, callback)
Ajoute des catégories à la liste principale d’une boîte aux lettres. Chaque catégorie doit avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.
addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Paramètres
- categories
Catégories à ajouter à la liste principale de la boîte aux lettres.
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContext
développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Facultatif. Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : boîte aux lettres en lecture/écriture
Mode Outlook applicable : Rédiger ou Lire
Erreurs :
DuplicateCategory
: l’une des catégories fournies figure déjà dans la liste des catégories principales.PermissionDenied
: l’utilisateur n’est pas autorisé à effectuer cette action.
Exemples
// 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)
Ajoute des catégories à la liste principale d’une boîte aux lettres. Chaque catégorie doit avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.
addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Paramètres
- categories
Catégories à ajouter à la liste principale de la boîte aux lettres.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Facultatif. Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : boîte aux lettres en lecture/écriture
Mode Outlook applicable : Rédiger ou Lire
Erreurs :
DuplicateCategory
: l’une des catégories fournies figure déjà dans la liste des catégories principales.PermissionDenied
: l’utilisateur n’est pas autorisé à effectuer cette action.
getAsync(options, callback)
Obtient la liste principale des catégories d’une boîte aux lettres.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;
Paramètres
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContext
développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.
- callback
-
(asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void
Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
. Si l’ajout de catégories échoue, la asyncResult.error
propriété contient un code d’erreur.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : boîte aux lettres en lecture/écriture
Mode Outlook applicable : Rédiger ou Lire
getAsync(callback)
Obtient la liste principale des catégories d’une boîte aux lettres.
getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;
Paramètres
- callback
-
(asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void
Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : boîte aux lettres en lecture/écriture
Mode Outlook applicable : Rédiger ou Lire
Exemples
// 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)
Supprime des catégories de la liste principale d’une boîte aux lettres.
removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Paramètres
- categories
-
string[]
Catégories à supprimer de la liste principale de la boîte aux lettres.
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContext
développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Facultatif. Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
. Si la suppression des catégories échoue, la asyncResult.error
propriété contient un code d’erreur.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : boîte aux lettres en lecture/écriture
Mode Outlook applicable : Rédiger ou Lire
Erreurs :
PermissionDenied
: l’utilisateur n’est pas autorisé à effectuer cette action.
Exemples
// 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)
Supprime des catégories de la liste principale d’une boîte aux lettres.
removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Paramètres
- categories
-
string[]
Catégories à supprimer de la liste principale de la boîte aux lettres.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Facultatif. Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
. Si la suppression des catégories échoue, la asyncResult.error
propriété contient un code d’erreur.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : boîte aux lettres en lecture/écriture
Mode Outlook applicable : Rédiger ou Lire
Erreurs :
PermissionDenied
: l’utilisateur n’est pas autorisé à effectuer cette action.
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour