Office.IsAllDayEvent interface

Paquet:

outlook

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 l’état d’événement d’une journée entière d’une réunion dans un complément Outlook.

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

Méthodes

getAsync(options, callback)	Obtient la valeur booléenne indiquant si l’événement est toute la journée ou non.
getAsync(callback)	Obtient la valeur booléenne indiquant si l’événement est toute la journée ou non.
setAsync(isAllDayEvent, options, callback)	Définit l’état d’un événement d’une journée entière d’un rendez-vous.
setAsync(isAllDayEvent, callback)	Définit l’état d’un é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.

Obtient la valeur booléenne indiquant si l’événement est toute la journée ou non.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => 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<boolean>) => 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 : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

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.

Obtient la valeur booléenne indiquant si l’événement est toute la journée ou non.

getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Paramètres

callback

(asyncResult: Office.AsyncResult<boolean>) => 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 : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/calendar-properties-apis.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 l’état d’un é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 l’état de l’événement toute la journée.

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

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, asyncResult, qui est un Office.AsyncResult objet .

Retours

void

Remarques

[ Ensemble 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 est marquée comme étant 00:00 (comme dans l’interface utilisateur Outlook). L’heure de début sera renvoyée à 12h00 et l’heure de fin sera 12h00 le lendemain.

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Composer

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/calendar-properties-apis.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 l’état d’un é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 l’état de l’événement toute la journée.

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, asyncResult, qui est un Office.AsyncResult objet .

Retours

void

Remarques

[ Ensemble 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 est marquée comme étant 00:00 (comme dans l’interface utilisateur Outlook). L’heure de début sera renvoyée à 12h00 et l’heure de fin sera 12h00 le lendemain.

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Composer