Office.SeriesTime interface

  • Référence
Paquet:
outlook

L’objet SeriesTime fournit des méthodes pour obtenir et définir les dates et heures des rendez-vous dans une série périodique et obtenir les dates et heures des demandes de réunion dans une série périodique.

Remarques

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

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

Mode Outlook applicable : Rédiger ou Lire

Méthodes

getDuration()

Obtient la durée en minutes d’une instance habituelle dans une série de rendez-vous récurrents.
getEndDate()

Obtient la date de fin d’un modèle de périodicité au format de date ISO 8601 suivant : « AAAA-MM-JJ ».
getEndTime()

Obtient l’heure de fin d’une instance de demande de rendez-vous ou de réunion habituelle d’un modèle de périodicité dans le fuseau horaire dans lequel l’utilisateur ou le complément définit le modèle de périodicité à l’aide du format ISO 8601 suivant : « THH:mm:ss:mmm ».
getStartDate()

Obtient la date de début d’un modèle de périodicité au format de date ISO 8601 suivant : « AAAA-MM-JJ ».
getStartTime()

Obtient l’heure de début d’une instance de rendez-vous habituelle d’un modèle de périodicité dans le fuseau horaire dans lequel l’utilisateur/complément définit le modèle de périodicité à l’aide du format ISO 8601 suivant : « THH:mm:ss:mmm ».
setDuration(minutes)

Définit la durée de tous les rendez-vous dans un modèle de périodicité. Cela modifie également l’heure de fin du modèle de périodicité.
setEndDate(year, month, day)

Définit la date de fin d’une série de rendez-vous périodiques.
setEndDate(date)

Définit la date de fin d’une série de rendez-vous périodiques.
setStartDate(year, month, day)

Définit la date de début d’une série de rendez-vous périodiques.
setStartDate(date)

Définit la date de début d’une série de rendez-vous périodiques.
setStartTime(hours, minutes)

Définit l’heure de début de toutes les instances d’une série de rendez-vous périodiques dans le fuseau horaire défini par le modèle de périodicité (le fuseau horaire de l’élément est utilisé par défaut).
setStartTime(time)

Définit l’heure de début de toutes les instances d’une série de rendez-vous périodiques dans le fuseau horaire défini par le modèle de périodicité (le fuseau horaire de l’élément est utilisé par défaut).

Détails de la méthode

getDuration()

Obtient la durée en minutes d’une instance habituelle dans une série de rendez-vous récurrents.

getDuration(): number;

Retours

number

Remarques

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

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

Mode Outlook applicable : Rédiger ou Lire

Exemples

// This example gets the duration of a usual instance in a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const duration = recurrence.seriesTime.getDuration();
}

getEndDate()

Obtient la date de fin d’un modèle de périodicité au format de date ISO 8601 suivant : « AAAA-MM-JJ ».

getEndDate(): string;

Retours

string

Remarques

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

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

Mode Outlook applicable : Rédiger ou Lire

Exemples

// This example gets the end date of a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getEndDate();
}

getEndTime()

Obtient l’heure de fin d’une instance de demande de rendez-vous ou de réunion habituelle d’un modèle de périodicité dans le fuseau horaire dans lequel l’utilisateur ou le complément définit le modèle de périodicité à l’aide du format ISO 8601 suivant : « THH:mm:ss:mmm ».

getEndTime(): string;

Retours

string

Remarques

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

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

Mode Outlook applicable : Rédiger ou Lire

Exemples

// This example gets the end time of a usual instance in a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getEndTime();
}

getStartDate()

Obtient la date de début d’un modèle de périodicité au format de date ISO 8601 suivant : « AAAA-MM-JJ ».

getStartDate(): string;

Retours

string

Remarques

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

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

Mode Outlook applicable : Rédiger ou Lire

Exemples

// This example gets the start date of a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getStartDate();
}

getStartTime()

Obtient l’heure de début d’une instance de rendez-vous habituelle d’un modèle de périodicité dans le fuseau horaire dans lequel l’utilisateur/complément définit le modèle de périodicité à l’aide du format ISO 8601 suivant : « THH:mm:ss:mmm ».

getStartTime(): string;

Retours

string

Remarques

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

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

Mode Outlook applicable : Rédiger ou Lire

Exemples

// This example gets the start time of a usual
// instance in a recurring appointment series.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setDuration(120);

setDuration(minutes)

Définit la durée de tous les rendez-vous dans un modèle de périodicité. Cela modifie également l’heure de fin du modèle de périodicité.

setDuration(minutes: number): void;

Paramètres

minutes

number

Durée du rendez-vous en minutes.

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Exemples

// This example sets the duration of each appointment
// in a recurring series to 2 hours.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getStartTime();
}

setEndDate(year, month, day)

Définit la date de fin d’une série de rendez-vous périodiques.

setEndDate(year: number, month: number, day: number): void;

Paramètres

year

number

Valeur d’année de la date de fin.

month

number

Valeur de mois de la date de fin. La plage valide est comprise entre 0 et 11, où 0 représente le 1er mois et 11 représente le 12e mois.

day

number

Valeur de jour de la date de fin.

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Exemples

// This example sets the end date of a recurring
// appointment series to November 2, 2017.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setEndDate(2017, 10, 2);

setEndDate(date)

Définit la date de fin d’une série de rendez-vous périodiques.

setEndDate(date: string): void;

Paramètres

date

string

Date de fin de la série de rendez-vous périodiques représentée au format de date ISO 8601 : « AAAA-MM-JJ ».

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Exemples

// This example sets the end date of a
// recurring appointment series to November 2, 2017
// using ISO 8601 date standard.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setEndDate("2017-11-02");

setStartDate(year, month, day)

Définit la date de début d’une série de rendez-vous périodiques.

setStartDate(year:number, month:number, day:number): void;

Paramètres

year

number

Valeur d’année de la date de début.

month

number

Valeur de mois de la date de début. La plage valide est comprise entre 0 et 11, où 0 représente le 1er mois et 11 représente le 12e mois.

day

number

Valeur de jour de la date de début.

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Exemples

// This example sets the start date of a recurring
// appointment series to November 2, 2017.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setStartDate(2017, 10, 2);

setStartDate(date)

Définit la date de début d’une série de rendez-vous périodiques.

setStartDate(date:string): void;

Paramètres

date

string

Date de début de la série de rendez-vous périodiques représentée au format de date ISO 8601 : « AAAA-MM-JJ ».

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Exemples

// This example sets the start date of a recurring
// appointment series to November 2, 2017
// using ISO 8601 date standard.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setStartDate("2017-11-02");

setStartTime(hours, minutes)

Définit l’heure de début de toutes les instances d’une série de rendez-vous périodiques dans le fuseau horaire défini par le modèle de périodicité (le fuseau horaire de l’élément est utilisé par défaut).

setStartTime(hours: number, minutes: number): void;

Paramètres

hours

number

Valeur d’heure de l’heure de début. Plage valide : 0-24.

minutes

number

Valeur de minute de l’heure de début. Plage valide : 0-59.

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Exemples

// This example sets the start time of each instance
// of a recurring appointment series to 1:30 PM.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setStartTime(13, 30);

// This example sets the start time of each instance
// of a recurring appointment series to 11:30 AM.
seriesTimeObject.setStartTime(11, 30);

setStartTime(time)

Définit l’heure de début de toutes les instances d’une série de rendez-vous périodiques dans le fuseau horaire défini par le modèle de périodicité (le fuseau horaire de l’élément est utilisé par défaut).

setStartTime(time: string): void;

Paramètres

time

string

Heure de début de toutes les instances représentées par le format de chaîne datetime standard : « THH:mm:ss:mmm ».

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Exemples

// This example sets the start time of each instance
// of a recurring appointment series to 11:30 PM.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setStartTime("T23:30:00");