Office.Time interface

  • Référence
Paquet:
outlook

L’objet Time est retourné en tant que propriété de début ou de fin d’un rendez-vous en mode composition.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

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

Mode Outlook applicable : Composer

Méthodes

getAsync(options, callback)

Obtient l’heure de début ou de fin d’un rendez-vous.

La date et l’heure sont fournies en tant qu’objet Date dans la asyncResult.value propriété . La valeur est exprimée au format UTC (temps universel coordonné). Vous pouvez convertir l’heure UTC en heure cliente locale à l’aide de la convertToLocalClientTime méthode .
getAsync(callback)

Obtient l’heure de début ou de fin d’un rendez-vous.

La date et l’heure sont fournies en tant qu’objet Date dans la asyncResult.value propriété . La valeur est exprimée au format UTC (temps universel coordonné). Vous pouvez convertir l’heure UTC en heure cliente locale à l’aide de la convertToLocalClientTime méthode .
setAsync(dateTime, options, callback)

Définit l’heure de début ou de fin d’un rendez-vous.

Si la setAsync méthode est appelée sur la propriété start, la end propriété est ajustée pour conserver la durée du rendez-vous définie précédemment. Si la méthode setAsync est appelée dans la propriété end, la durée du rendez-vous est étendue jusqu’à la nouvelle heure de fin.

La durée doit être exprimée au format UTC. Vous pouvez obtenir l’heure UTC correcte à l’aide de la méthode convertToUtcClientTime.

Important : Dans le client Windows, vous ne pouvez pas utiliser cette méthode pour mettre à jour le début ou la fin d’une périodicité.
setAsync(dateTime, callback)

Définit l’heure de début ou de fin d’un rendez-vous.

Si la setAsync méthode est appelée sur la propriété start, la end propriété est ajustée pour conserver la durée du rendez-vous définie précédemment. Si la méthode setAsync est appelée dans la propriété end, la durée du rendez-vous est étendue jusqu’à la nouvelle heure de fin.

La durée doit être exprimée au format UTC. Vous pouvez obtenir l’heure UTC correcte à l’aide de la méthode convertToUtcClientTime.

Important : Dans le client Windows, vous ne pouvez pas utiliser cette méthode pour mettre à jour le début ou la fin d’une périodicité.

Détails de la méthode

getAsync(options, callback)

Obtient l’heure de début ou de fin d’un rendez-vous.

La date et l’heure sont fournies en tant qu’objet Date dans la asyncResult.value propriété . La valeur est exprimée au format UTC (temps universel coordonné). Vous pouvez convertir l’heure UTC en heure cliente locale à l’aide de la convertToLocalClientTime méthode .

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => 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<Date>) => 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 un Date objet .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

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

Mode Outlook applicable : Composer

getAsync(callback)

Obtient l’heure de début ou de fin d’un rendez-vous.

La date et l’heure sont fournies en tant qu’objet Date dans la asyncResult.value propriété . La valeur est exprimée au format UTC (temps universel coordonné). Vous pouvez convertir l’heure UTC en heure cliente locale à l’aide de la convertToLocalClientTime méthode .

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

Paramètres

callback

(asyncResult: Office.AsyncResult<Date>) => void

Une fois la méthode terminée, la fonction passée dans le paramètre de rappel est appelée avec un seul paramètre de type Office.AsyncResult. La value propriété du résultat est un Date objet .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

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/90-other-item-apis/get-set-start-appointment-organizer.yaml

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment starts: ${result.value}`);
});

setAsync(dateTime, options, callback)

Définit l’heure de début ou de fin d’un rendez-vous.

Si la setAsync méthode est appelée sur la propriété start, la end propriété est ajustée pour conserver la durée du rendez-vous définie précédemment. Si la méthode setAsync est appelée dans la propriété end, la durée du rendez-vous est étendue jusqu’à la nouvelle heure de fin.

La durée doit être exprimée au format UTC. Vous pouvez obtenir l’heure UTC correcte à l’aide de la méthode convertToUtcClientTime.

Important : Dans le client Windows, vous ne pouvez pas utiliser cette méthode pour mettre à jour le début ou la fin d’une périodicité.

setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

dateTime

Date

Objet date-heure en temps universel coordonné (UTC).

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 de type Office.AsyncResult. Si la définition de la date et de l’heure é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 en lecture/écriture

Mode Outlook applicable : Composer

Erreurs :

  • InvalidEndTime: l’heure de fin du rendez-vous est antérieure à l’heure de début du rendez-vous.

Exemples

const startTime = new Date("3/14/2015");
const options = {
    // Pass information that can be used in the callback.
    asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.start.setAsync(startTime, options, function(result) {
    if (result.error) {
        console.debug(result.error);
    } else {
        // Access the asyncContext that was passed to the setAsync method.
        console.debug("Start Time " + result.asyncContext.verb);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml

const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

...

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  const end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

setAsync(dateTime, callback)

Définit l’heure de début ou de fin d’un rendez-vous.

Si la setAsync méthode est appelée sur la propriété start, la end propriété est ajustée pour conserver la durée du rendez-vous définie précédemment. Si la méthode setAsync est appelée dans la propriété end, la durée du rendez-vous est étendue jusqu’à la nouvelle heure de fin.

La durée doit être exprimée au format UTC. Vous pouvez obtenir l’heure UTC correcte à l’aide de la méthode convertToUtcClientTime.

Important : Dans le client Windows, vous ne pouvez pas utiliser cette méthode pour mettre à jour le début ou la fin d’une périodicité.

setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

dateTime

Date

Objet date-heure en temps universel coordonné (UTC).

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 définition de la date et de l’heure é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 en lecture/écriture

Mode Outlook applicable : Composer

Erreurs :

  • InvalidEndTime: l’heure de fin du rendez-vous est antérieure à l’heure de début du rendez-vous.