Office.Recurrence interface

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

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Zustände

State	Bearbeitbar?	Sichtbar?
Terminorganisator – Serie Compose	Ja (setAsync)	Ja (getAsync)
Terminorganisator – Instanz Compose	Nein (setAsync gibt einen Fehler zurück)	Ja (getAsync)
Terminteilnehmer – Serie lesen	Nein (setAsync nicht verfügbar)	Ja (item.recurrence)
Terminteilnehmer – Instanz lesen	Nein (setAsync nicht verfügbar)	Ja (item.recurrence)
Besprechungsanfrage – Serie lesen	Nein (setAsync nicht verfügbar)	Ja (item.recurrence)
Besprechungsanfrage – Instanz lesen	Nein (setAsync nicht verfügbar)	Ja (item.recurrence)

Verwendet von

Eigenschaften

recurrenceProperties	Ruft die Eigenschaften der Terminserie ab oder legt sie fest.
recurrenceTimeZone	Ruft die Eigenschaften der Terminserie ab oder legt sie fest.
recurrenceType	Ruft den Typ der Terminserie ab oder legt ihn fest.
seriesTime	Mit dem SeriesTime-Objekt können Sie das Start- und Enddatum der Terminserien sowie die üblichen Start- und Endzeiten von Instanzen verwalten. Dieses Objekt befindet sich nicht in UTC-Zeit. Stattdessen wird sie in der durch den `recurrenceTimeZone` Wert angegebenen Zeitzone festgelegt oder standardmäßig auf die Zeitzone des Elements festgelegt.

Methoden

getAsync(options, callback)	Gibt das aktuelle Serienobjekt einer Terminserie zurück. Diese Methode gibt das gesamte `Recurrence` Objekt für die Terminserie zurück.
getAsync(callback)	Gibt das aktuelle Serienobjekt einer Terminserie zurück. Diese Methode gibt das gesamte `Recurrence` Objekt für die Terminserie zurück.
setAsync(recurrencePattern, options, callback)	Legt das Serienmuster einer Terminserie fest.
setAsync(recurrencePattern, callback)	Legt das Serienmuster einer Terminserie fest.

recurrenceProperties

Ruft die Eigenschaften der Terminserie ab oder legt sie fest.

recurrenceProperties?: RecurrenceProperties;

Eigenschaftswert

Office.RecurrenceProperties

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

recurrenceTimeZone

Ruft die Eigenschaften der Terminserie ab oder legt sie fest.

recurrenceTimeZone?: RecurrenceTimeZone;

Eigenschaftswert

Office.RecurrenceTimeZone

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

recurrenceType

Ruft den Typ der Terminserie ab oder legt ihn fest.

recurrenceType: MailboxEnums.RecurrenceType | string;

Eigenschaftswert

Office.MailboxEnums.RecurrenceType | string

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

seriesTime

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

seriesTime: SeriesTime;

Eigenschaftswert

Office.SeriesTime

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

getAsync(options, callback)

Gibt das aktuelle Serienobjekt einer Terminserie zurück.

Diese Methode gibt das gesamte Recurrence Objekt für die Terminserie 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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

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, asyncResultder ein Office.AsyncResult Objekt ist. Die value Eigenschaft des Ergebnisses ist ein Recurrence Objekt.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

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 Terminserie zurück.

Diese Methode gibt das gesamte Recurrence Objekt für die Terminserie 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, asyncResultder ein Office.AsyncResult Objekt ist. Die value Eigenschaft des Ergebnisses ist ein Recurrence Objekt.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

setAsync(recurrencePattern, options, callback)

Legt das Serienmuster einer Terminserie fest.

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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

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

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

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig:

setAsyncist nur für Serienelemente und nicht für instance-Elemente verfügbar.
Die setAsync Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter "Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten".

Fehler:

InvalidEndTime : Das Ende des Termins 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 = {
  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 as any, (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 Terminserie fest.

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, asyncResultder ein Office.AsyncResult Objekt ist.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig:

setAsyncist nur für Serienelemente und nicht für instance-Elemente verfügbar.
Die setAsync Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter "Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten".

Fehler:

InvalidEndTime : Das Ende des Termins liegt vor der Startzeit.

Hinweise

Verwendet von

Eigenschaften

Methoden

Details zur Eigenschaft

recurrenceProperties

Eigenschaftswert

Hinweise

recurrenceTimeZone

Eigenschaftswert

Hinweise

recurrenceType

Eigenschaftswert

Hinweise

seriesTime

Eigenschaftswert

Hinweise

Details zur Methode

getAsync(options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

getAsync(callback)

Parameter

Gibt zurück

Hinweise

setAsync(recurrencePattern, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

setAsync(recurrencePattern, callback)

Parameter

Gibt zurück

Hinweise

Feedback