Office.IsAllDayEvent interface
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Fournit des méthodes pour obtenir et définir le status d’événement d’une réunion sur une journée entière dans un complément Outlook.
Remarques
Jeu d’API : préversion de boîte aux lettres
Niveau d’autorisation minimal : lire l’élément
Mode Outlook applicable : Compose
Utilisateur
Méthodes
| get |
Récupère la valeur booléenne indiquant si l’événement a lieu toute la journée ou non. |
| get |
Récupère la valeur booléenne indiquant si l’événement a lieu toute la journée ou non. |
| set |
Définit le status de l’événement d’une journée entière d’un rendez-vous. |
| set |
Définit le status de l’événement d’une journée entière d’un rendez-vous. |
Détails de la méthode
getAsync(options, callback)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Récupère la valeur booléenne indiquant si l’événement a lieu toute la journée ou non.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;Paramètres
- options
- Office.AsyncContextOptions
Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
Lorsque la méthode est 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
Jeu d’API : préversion de boîte aux lettres
Niveau d’autorisation minimal : lire l’élément
Mode Outlook applicable : Compose
getAsync(callback)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Récupère la valeur booléenne indiquant si l’événement a lieu toute la journée ou non.
getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;Paramètres
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
Lorsque la méthode est 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
Jeu d’API : préversion de boîte aux lettres
Niveau d’autorisation minimal : lire l’élément
Mode Outlook applicable : Compose
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Is this an all-day event? " + asyncResult.value);
} else {
console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
}
});
setAsync(isAllDayEvent, options, callback)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Définit le status de l’événement d’une journée entière d’un rendez-vous.
setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Paramètres
- isAllDayEvent
-
boolean
Valeur booléenne pour définir le status de l’événement toute la journée.
- options
- Office.AsyncContextOptions
Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les 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. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet.
Retours
void
Remarques
Jeu d’API : préversion de boîte aux lettres
Si un rendez-vous est marqué comme un événement d’une journée entière : - L’heure de début et de fin sera définie sur 12h00 (comme dans l’interface utilisateur d’Outlook). L’heure de début sera de retour à minuit et l’heure de fin sera minuit le lendemain.
Niveau d’autorisation minimal : lecture/écriture d’élément
Mode Outlook applicable : Compose
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
} else {
console.log("Appointment set to all-day event.");
}
});
setAsync(isAllDayEvent, callback)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Définit le status de l’événement d’une journée entière d’un rendez-vous.
setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Paramètres
- isAllDayEvent
-
boolean
Valeur booléenne pour définir le status de l’événement toute la journée.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet.
Retours
void
Remarques
Jeu d’API : préversion de boîte aux lettres
Si un rendez-vous est marqué comme un événement d’une journée entière : - L’heure de début et de fin sera définie sur 12h00 (comme dans l’interface utilisateur d’Outlook). L’heure de début sera de retour à minuit et l’heure de fin sera minuit le lendemain.
Niveau d’autorisation minimal : lecture/écriture d’élément
Mode Outlook applicable : Compose