Office.Recurrence interface

  • Référence
Paquet:
outlook

L’objet Recurrence fournit des méthodes pour obtenir et définir le modèle de périodicité des rendez-vous, mais uniquement le modèle de périodicité des demandes de réunion. Il aura un dictionnaire avec les clés suivantes : seriesTime, recurrenceType, recurrencePropertieset recurrenceTimeZone (facultatif).

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

États

État Modifiable? Visible?
Organisateur de rendez-vous - Série Composer Oui (setAsync) Oui (getAsync)
Organisateur de rendez-vous - Composer une instance Non (setAsync retourne une erreur) Oui (getAsync)
Participant au rendez-vous - Série Lecture Non (setAsync non disponible) Oui (item.recurrence)
Participant au rendez-vous - Instance de lecture Non (setAsync non disponible) Oui (item.recurrence)
Demande de réunion - Série lecture Non (setAsync non disponible) Oui (item.recurrence)
Demande de réunion - Instance de lecture Non (setAsync non disponible) Oui (item.recurrence)

Propriétés

recurrenceProperties

Obtient ou définit les propriétés de la série de rendez-vous périodiques.
recurrenceTimeZone

Obtient ou définit les propriétés de la série de rendez-vous périodiques.
recurrenceType

Obtient ou définit le type de la série de rendez-vous périodiques.
seriesTime

L’objet SeriesTime vous permet de gérer les dates de début et de fin de la série de rendez-vous périodiques, ainsi que les heures de début et de fin habituelles des instances. Cet objet n’est pas en heure UTC. Au lieu de cela, il est défini dans le fuseau horaire spécifié par la recurrenceTimeZone valeur ou défini par défaut sur le fuseau horaire de l’élément.

Méthodes

getAsync(options, callback)

Retourne l’objet de périodicité actuel d’une série de rendez-vous.

Cette méthode retourne l’objet entier Recurrence pour la série de rendez-vous.
getAsync(callback)

Retourne l’objet de périodicité actuel d’une série de rendez-vous.

Cette méthode retourne l’objet entier Recurrence pour la série de rendez-vous.
setAsync(recurrencePattern, options, callback)

Définit le modèle de périodicité d’une série de rendez-vous.

Remarque : setAsync doit être disponible uniquement pour les éléments de série et non pour les éléments d’instance.
setAsync(recurrencePattern, callback)

Définit le modèle de périodicité d’une série de rendez-vous.

Remarque : setAsync doit être disponible uniquement pour les éléments de série et non pour les éléments d’instance.

Détails de la propriété

recurrenceProperties

Obtient ou définit les propriétés de la série de rendez-vous périodiques.

recurrenceProperties?: RecurrenceProperties;

Valeur de propriété

Office.RecurrenceProperties

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

recurrenceTimeZone

Obtient ou définit les propriétés de la série de rendez-vous périodiques.

recurrenceTimeZone?: RecurrenceTimeZone;

Valeur de propriété

Office.RecurrenceTimeZone

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

recurrenceType

Obtient ou définit le type de la série de rendez-vous périodiques.

recurrenceType: MailboxEnums.RecurrenceType | string;

Valeur de propriété

Office.MailboxEnums.RecurrenceType | 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

seriesTime

L’objet SeriesTime vous permet de gérer les dates de début et de fin de la série de rendez-vous périodiques, ainsi que les heures de début et de fin habituelles des instances. Cet objet n’est pas en heure UTC. Au lieu de cela, il est défini dans le fuseau horaire spécifié par la recurrenceTimeZone valeur ou défini par défaut sur le fuseau horaire de l’élément.

seriesTime: SeriesTime;

Valeur de propriété

Office.SeriesTime

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

Détails de la méthode

getAsync(options, callback)

Retourne l’objet de périodicité actuel d’une série de rendez-vous.

Cette méthode retourne l’objet entier Recurrence pour la série de rendez-vous.

getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Recurrence>) => 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<Office.Recurrence>) => 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 . La value propriété du résultat est un Recurrence objet .

Retours

void

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

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

Office.context.mailbox.item.recurrence.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const recurrence = asyncResult.value;
    if (recurrence === null) {
      console.log("This is a single appointment.");
    } else {
      console.log(`Recurrence pattern: ${JSON.stringify(recurrence)}`);
    }
  } else {
    console.error(asyncResult.error);
  }
});

getAsync(callback)

Retourne l’objet de périodicité actuel d’une série de rendez-vous.

Cette méthode retourne l’objet entier Recurrence pour la série de rendez-vous.

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

Paramètres

callback

(asyncResult: Office.AsyncResult<Office.Recurrence>) => 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 . La value propriété du résultat est un Recurrence objet .

Retours

void

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

setAsync(recurrencePattern, options, callback)

Définit le modèle de périodicité d’une série de rendez-vous.

Remarque : setAsync doit être disponible uniquement pour les éléments de série et non pour les éléments d’instance.

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

Paramètres

recurrencePattern
Office.Recurrence

Objet de périodicité.

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 : Boîte aux lettres 1.7 ]

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 à son heure de début.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

// Important: Can only set the recurrence pattern of an appointment series.

const currentDate = new Date();
let seriesTimeObject: Office.SeriesTime;
// Set series start date to tomorrow.
seriesTimeObject.setStartDate(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDay() + 1);
// Set series end date to one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern: Office.Recurrence = {
  seriesTime: seriesTimeObject,
  recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
  recurrenceProperties: {
    interval: 1,
    dayOfWeek: Office.MailboxEnums.Days.Tue,
    weekNumber: Office.MailboxEnums.WeekNumber.Second,
    month: Office.MailboxEnums.Month.Sep
  },
  recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern, (asyncResult) => {
  if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to set recurrence. Error: ${asyncResult.error.message}`);
    return;
  }
  console.log(`Succeeded in setting recurrence pattern ${JSON.stringify(pattern)}`);
});

setAsync(recurrencePattern, callback)

Définit le modèle de périodicité d’une série de rendez-vous.

Remarque : setAsync doit être disponible uniquement pour les éléments de série et non pour les éléments d’instance.

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

Paramètres

recurrencePattern
Office.Recurrence

Objet de périodicité.

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 : Boîte aux lettres 1.7 ]

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 à son heure de début.