Office.IsAllDayEvent interface
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Stellt Methoden zum Abrufen und Festlegen der ganztägigen Ereignis-status einer Besprechung in einem Outlook-Add-In bereit.
Methoden
| get |
Ruft den booleschen Wert ab, der angibt, ob das Ereignis ganztägig ist oder nicht. |
| get |
Ruft den booleschen Wert ab, der angibt, ob das Ereignis ganztägig ist oder nicht. |
| set |
Legt den ganztägigen Ereignis-Status eines Termins fest. |
| set |
Legt den ganztägigen Ereignis-Status eines Termins fest. |
Details zur Methode
getAsync(options, callback)
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den booleschen Wert ab, der angibt, ob das Ereignis ganztägig ist oder nicht.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => 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<boolean>) => void
Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose
getAsync(callback)
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den booleschen Wert ab, der angibt, ob das Ereignis ganztägig ist oder nicht.
getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;Parameter
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Is this an all-day event? " + asyncResult.value);
} else {
console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
}
});
setAsync(isAllDayEvent, options, callback)
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Legt den ganztägigen Ereignis-Status eines Termins fest.
setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- isAllDayEvent
-
boolean
Boolescher Wert, um den ganztägigen Ereignis-Status festzulegen.
- 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
Wenn ein Termin als ganztägiges Ereignis markiert ist: – Start- und Endzeit werden mit 12:00 Uhr gekennzeichnet (genau wie in der Outlook-Benutzeroberfläche). Die Startzeit wird um 12:00 Uhr angezeigt, und die Endzeit ist um 12:00 Uhr am nächsten Tag.
Mindestberechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Compose
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
} else {
console.log("Appointment set to all-day event.");
}
});
setAsync(isAllDayEvent, callback)
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Legt den ganztägigen Ereignis-Status eines Termins fest.
setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- isAllDayEvent
-
boolean
Boolescher Wert, um den ganztägigen Ereignis-Status festzulegen.
- 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
Wenn ein Termin als ganztägiges Ereignis markiert ist: – Start- und Endzeit werden mit 12:00 Uhr gekennzeichnet (genau wie in der Outlook-Benutzeroberfläche). Die Startzeit wird um 12:00 Uhr angezeigt, und die Endzeit ist um 12:00 Uhr am nächsten Tag.
Mindestberechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Compose