Office.Recurrence interface

  • Referenz
Paket:
outlook

Das Recurrence -Objekt stellt Methoden bereit, um das Serienmuster von Terminen abzurufen und festzulegen, aber nur das Wiederholungsmuster von Besprechungsanfragen abzurufen. Es verfügt über ein Wörterbuch mit den folgenden Schlüsseln: seriesTime, recurrenceType, recurrencePropertiesund recurrenceTimeZone (optional).

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Zustände

Status Bearbeitbaren? Sichtbar?
Terminplaner – Reihe verfassen Ja (setAsync) Ja (getAsync)
Terminorganisation – Compose-Instanz Nein (setAsync gibt fehler zurück) Ja (getAsync)
Terminteilnehmer – Reihe lesen Nein (setAsync nicht verfügbar) Ja (item.recurrence)
Terminteilnehmer – Leseinstanz Nein (setAsync nicht verfügbar) Ja (item.recurrence)
Besprechungsanfrage – Lesereihe Nein (setAsync nicht verfügbar) Ja (item.recurrence)
Besprechungsanfrage – Leseinstanz Nein (setAsync nicht verfügbar) Ja (item.recurrence)

Eigenschaften

recurrenceProperties

Ruft die Eigenschaften der Terminserie ab oder legt diese fest.
recurrenceTimeZone

Ruft die Eigenschaften der Terminserie ab oder legt diese fest.
recurrenceType

Ruft den Typ der Terminserie ab oder legt den Typ fest.
seriesTime

Mit dem SeriesTime-Objekt können Sie das Start- und Enddatum der Terminserie sowie die üblichen Start- und Endzeiten von Instanzen verwalten. Dieses Objekt befindet sich nicht in UTC-Zeit. Stattdessen wird sie in der Zeitzone festgelegt, die durch den recurrenceTimeZone Wert oder standardmäßig auf die Zeitzone des Elements festgelegt wird.

Methoden

getAsync(options, callback)

Gibt das aktuelle Serienobjekt einer Terminreihe zurück.

Diese Methode gibt das gesamte Recurrence Objekt für die Terminreihe zurück.
getAsync(callback)

Gibt das aktuelle Serienobjekt einer Terminreihe zurück.

Diese Methode gibt das gesamte Recurrence Objekt für die Terminreihe zurück.
setAsync(recurrencePattern, options, callback)

Legt das Serienmuster einer Terminreihe fest.

Hinweis: setAsync sollte nur für Reihenelemente und nicht für Instanzelemente verfügbar sein.
setAsync(recurrencePattern, callback)

Legt das Serienmuster einer Terminreihe fest.

Hinweis: setAsync sollte nur für Reihenelemente und nicht für Instanzelemente verfügbar sein.

Details zur Eigenschaft

recurrenceProperties

Ruft die Eigenschaften der Terminserie ab oder legt diese fest.

recurrenceProperties?: RecurrenceProperties;

Eigenschaftswert

Office.RecurrenceProperties

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

recurrenceTimeZone

Ruft die Eigenschaften der Terminserie ab oder legt diese fest.

recurrenceTimeZone?: RecurrenceTimeZone;

Eigenschaftswert

Office.RecurrenceTimeZone

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

recurrenceType

Ruft den Typ der Terminserie ab oder legt den Typ fest.

recurrenceType: MailboxEnums.RecurrenceType | string;

Eigenschaftswert

Office.MailboxEnums.RecurrenceType | string

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

seriesTime

Mit dem SeriesTime-Objekt können Sie das Start- und Enddatum der Terminserie sowie die üblichen Start- und Endzeiten von Instanzen verwalten. Dieses Objekt befindet sich nicht in UTC-Zeit. Stattdessen wird sie in der Zeitzone festgelegt, die durch den recurrenceTimeZone Wert oder standardmäßig auf die Zeitzone des Elements festgelegt wird.

seriesTime: SeriesTime;

Eigenschaftswert

Office.SeriesTime

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Details zur Methode

getAsync(options, callback)

Gibt das aktuelle Serienobjekt einer Terminreihe zurück.

Diese Methode gibt das gesamte Recurrence Objekt für die Terminreihe zurück.

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

Parameter

options
Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die value -Eigenschaft des Ergebnisses ist ein Recurrence -Objekt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Beispiele

// 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)

Gibt das aktuelle Serienobjekt einer Terminreihe zurück.

Diese Methode gibt das gesamte Recurrence Objekt für die Terminreihe zurück.

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

Parameter

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die value -Eigenschaft des Ergebnisses ist ein Recurrence -Objekt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

setAsync(recurrencePattern, options, callback)

Legt das Serienmuster einer Terminreihe fest.

Hinweis: setAsync sollte nur für Reihenelemente und nicht für Instanzelemente verfügbar sein.

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

Parameter

recurrencePattern
Office.Recurrence

Ein Serienobjekt.

options
Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.7 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen

Fehler:

  • InvalidEndTime: Die Terminendzeit liegt vor der Startzeit.

Beispiele

// 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)

Legt das Serienmuster einer Terminreihe fest.

Hinweis: setAsync sollte nur für Reihenelemente und nicht für Instanzelemente verfügbar sein.

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

Parameter

recurrencePattern
Office.Recurrence

Ein Serienobjekt.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.7 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen

Fehler:

  • InvalidEndTime: Die Terminendzeit liegt vor der Startzeit.