Office.Time interface

Das Time Objekt wird als Start- oder Endeigenschaft eines Termins im Erstellungsmodus zurückgegeben.

Methoden

getAsync(options, callback)

Ruft die Start- oder Endzeit eines Termins ab.

Datum und Uhrzeit werden als Date Objekt in der asyncResult.value Eigenschaft bereitgestellt. Der Wert wird in UTC (Coordinated Universal Time) angegeben. Sie können die UTC-Zeit mit der convertToLocalClientTime folgenden Methode in die lokale Clientzeit konvertieren.

getAsync(callback)

Ruft die Start- oder Endzeit eines Termins ab.

Datum und Uhrzeit werden als Date Objekt in der asyncResult.value Eigenschaft bereitgestellt. Der Wert wird in UTC (Coordinated Universal Time) angegeben. Sie können die UTC-Zeit mit der convertToLocalClientTime folgenden Methode in die lokale Clientzeit konvertieren.

setAsync(dateTime, options, callback)

Legt die Start- oder Endzeit eines Termins fest.

Wenn die setAsync Methode für die Starteigenschaft aufgerufen wird, wird die end Eigenschaft angepasst, um die zuvor festgelegte Dauer des Termins beizubehalten. Wenn die setAsync-Methode für die end-Eigenschaft aufgerufen wird, wird die Dauer des Termins bis zur neuen Endzeit verlängert.

Die Uhrzeit muss UTC-Format aufweisen; Sie können mithilfe der convertToUtcClientTime-Methode die korrekte UTC-Uhrzeit abrufen.

Wichtig: Im Windows-Client können Sie diese Methode nicht verwenden, um den Anfang oder das Ende einer Wiederholung zu aktualisieren.

setAsync(dateTime, callback)

Legt die Start- oder Endzeit eines Termins fest.

Wenn die setAsync Methode für die Starteigenschaft aufgerufen wird, wird die end Eigenschaft angepasst, um die zuvor festgelegte Dauer des Termins beizubehalten. Wenn die setAsync-Methode für die end-Eigenschaft aufgerufen wird, wird die Dauer des Termins bis zur neuen Endzeit verlängert.

Die Uhrzeit muss UTC-Format aufweisen; Sie können mithilfe der convertToUtcClientTime-Methode die korrekte UTC-Uhrzeit abrufen.

Wichtig: Im Windows-Client können Sie diese Methode nicht verwenden, um den Anfang oder das Ende einer Wiederholung zu aktualisieren.

Details zur Methode

getAsync(options, callback)

Ruft die Start- oder Endzeit eines Termins ab.

Datum und Uhrzeit werden als Date Objekt in der asyncResult.value Eigenschaft bereitgestellt. Der Wert wird in UTC (Coordinated Universal Time) angegeben. Sie können die UTC-Zeit mit der convertToLocalClientTime folgenden Methode in die lokale Clientzeit konvertieren.

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

Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Die value Eigenschaft des Ergebnisses ist ein Date Objekt.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

getAsync(callback)

Ruft die Start- oder Endzeit eines Termins ab.

Datum und Uhrzeit werden als Date Objekt in der asyncResult.value Eigenschaft bereitgestellt. Der Wert wird in UTC (Coordinated Universal Time) angegeben. Sie können die UTC-Zeit mit der convertToLocalClientTime folgenden Methode in die lokale Clientzeit konvertieren.

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

Parameter

callback

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

Wenn die Methode abgeschlossen ist, wird die im Rückrufparameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResult. Die value Eigenschaft des Ergebnisses ist ein Date Objekt.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

Beispiele

// 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;
  }

  const time = result.value;
  const localTime = Office.context.mailbox.convertToLocalClientTime(time);
  console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});

setAsync(dateTime, options, callback)

Legt die Start- oder Endzeit eines Termins fest.

Wenn die setAsync Methode für die Starteigenschaft aufgerufen wird, wird die end Eigenschaft angepasst, um die zuvor festgelegte Dauer des Termins beizubehalten. Wenn die setAsync-Methode für die end-Eigenschaft aufgerufen wird, wird die Dauer des Termins bis zur neuen Endzeit verlängert.

Die Uhrzeit muss UTC-Format aufweisen; Sie können mithilfe der convertToUtcClientTime-Methode die korrekte UTC-Uhrzeit abrufen.

Wichtig: Im Windows-Client können Sie diese Methode nicht verwenden, um den Anfang oder das Ende einer Wiederholung zu aktualisieren.

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

Parameter

dateTime

Date

Ein Datum/Uhrzeitobjekt in koordinierter Weltzeit (UTC).

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 vom Typ Office.AsyncResultaufgerufen. Wenn das Festlegen von Datum und Uhrzeit fehlschlägt, enthält die asyncResult.error-Eigenschaft einen Fehlercode.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Fehler:

  • InvalidEndTime : Die Endzeit des Termins liegt vor der Startzeit des Termins.

Beispiele

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

Legt die Start- oder Endzeit eines Termins fest.

Wenn die setAsync Methode für die Starteigenschaft aufgerufen wird, wird die end Eigenschaft angepasst, um die zuvor festgelegte Dauer des Termins beizubehalten. Wenn die setAsync-Methode für die end-Eigenschaft aufgerufen wird, wird die Dauer des Termins bis zur neuen Endzeit verlängert.

Die Uhrzeit muss UTC-Format aufweisen; Sie können mithilfe der convertToUtcClientTime-Methode die korrekte UTC-Uhrzeit abrufen.

Wichtig: Im Windows-Client können Sie diese Methode nicht verwenden, um den Anfang oder das Ende einer Wiederholung zu aktualisieren.

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

Parameter

dateTime

Date

Ein Datum/Uhrzeitobjekt in koordinierter Weltzeit (UTC).

callback

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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn das Festlegen von Datum und Uhrzeit fehlschlägt, enthält die asyncResult.error-Eigenschaft einen Fehlercode.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Fehler:

  • InvalidEndTime : Die Endzeit des Termins liegt vor der Startzeit des Termins.