Office.Subject interface
Fournit des méthodes pour obtenir et définir l’objet d’un rendez-vous ou d’un message dans un complément Outlook.
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Compose
Méthodes
| get |
Obtient l’objet d’un rendez-vous ou d’un message. La méthode |
| get |
Obtient l’objet d’un rendez-vous ou d’un message. La méthode |
| set |
Définit l’objet d’un rendez-vous ou d’un message. La méthode |
| set |
Définit l’objet d’un rendez-vous ou d’un message. La méthode |
Détails de la méthode
getAsync(options, callback)
Obtient l’objet d’un rendez-vous ou d’un message.
La méthode getAsync lance un appel asynchrone vers le serveur Exchange pour obtenir l’objet d’un rendez-vous ou d’un message.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;Paramètres
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.
- callback
-
(asyncResult: Office.AsyncResult<string>) => 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. La value propriété du résultat est l’objet de l’élément.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Compose
getAsync(callback)
Obtient l’objet d’un rendez-vous ou d’un message.
La méthode getAsync lance un appel asynchrone vers le serveur Exchange pour obtenir l’objet d’un rendez-vous ou d’un message.
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;Paramètres
- callback
-
(asyncResult: Office.AsyncResult<string>) => 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. La value propriété du résultat est l’objet de l’élément.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Compose
Exemples
Office.context.mailbox.item.subject.getAsync(callback);
function callback(asyncResult) {
const subject = asyncResult.value;
}
setAsync(subject, options, callback)
Définit l’objet d’un rendez-vous ou d’un message.
La méthode setAsync lance un appel asynchrone vers le serveur Exchange pour définir l’objet d’un rendez-vous ou d’un message. La définition de l’objet remplace l’objet actuel, mais laisse tous les préfixes, tels que « Tr: » ou « Re: ».
setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Paramètres
- subject
-
string
Objet du rendez-vous ou du message. La chaîne est limitée à 255 caractères.
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. 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 définition de l’objet échoue, la propriété asyncResult.error contient un code d’erreur.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Compose
Important:
Dans Outlook sur Android et sur iOS, cette méthode n’est pas prise en charge en mode message Compose. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.
La
setAsyncméthode n’est pas prise en charge sur un message actuellement chargé à l’aide de laloadItemByIdAsyncméthode . Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.
Erreurs :
-
DataExceedsMaximumSize: le paramètre subject comporte plus de 255 caractères.
Exemples
Office.context.mailbox.item.subject.setAsync("New subject!", function (asyncResult) {
if (asyncResult.status === "failed") {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
setAsync(subject, callback)
Définit l’objet d’un rendez-vous ou d’un message.
La méthode setAsync lance un appel asynchrone vers le serveur Exchange pour définir l’objet d’un rendez-vous ou d’un message. La définition de l’objet remplace l’objet actuel, mais laisse tous les préfixes, tels que « Tr: » ou « Re: ».
setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Paramètres
- subject
-
string
Objet du rendez-vous ou du message. La chaîne est limitée à 255 caractères.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. 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 définition de l’objet échoue, la propriété asyncResult.error contient un code d’erreur.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Compose
Important:
Dans Outlook sur Android et sur iOS, cette méthode n’est pas prise en charge en mode message Compose. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.
La
setAsyncméthode n’est pas prise en charge sur un message actuellement chargé à l’aide de laloadItemByIdAsyncméthode . Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.
Erreurs :
-
DataExceedsMaximumSize: le paramètre subject comporte plus de 255 caractères.