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 des ganztägigen Ereignisses status einer Besprechung in einem Outlook-Add-In bereit.
Hinweise
[ API-Satz: Postfachvorschau ]
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose
Methoden
| get |
Ruft den booleschen Wert ab, der angibt, ob das Ereignis den ganzen Tag hat oder nicht. |
| get |
Ruft den booleschen Wert ab, der angibt, ob das Ereignis den ganzen Tag hat oder nicht. |
| set |
Legt das ganztägige Ereignis status eines Termins fest. |
| set |
Legt das ganztägige 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 den ganzen Tag hat 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: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.
- 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
[ API-Satz: Postfachvorschau ]
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 den ganzen Tag hat 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
[ API-Satz: Postfachvorschau ]
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 das ganztägige Ereignis status eines Termins fest.
setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- isAllDayEvent
-
boolean
Boolescher Wert zum Festlegen des ganztägigen Ereignisses status.
- 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: Postfachvorschau ]
Wenn ein Termin als ganztägiges Ereignis markiert ist: - Start- und Endzeit werden als 12:00 Uhr markiert (genau wie in der Outlook-Benutzeroberfläche). Die Startzeit wird um 12:00 Uhr und die Endzeit um 12:00 Uhr am nächsten Tag zurückgegeben.
Minimale Berechtigungsstufe: 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 das ganztägige Ereignis status eines Termins fest.
setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- isAllDayEvent
-
boolean
Boolescher Wert zum Festlegen des ganztägigen Ereignisses status.
- 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: Postfachvorschau ]
Wenn ein Termin als ganztägiges Ereignis markiert ist: - Start- und Endzeit werden als 12:00 Uhr markiert (genau wie in der Outlook-Benutzeroberfläche). Die Startzeit wird um 12:00 Uhr und die Endzeit um 12:00 Uhr am nächsten Tag zurückgegeben.
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Compose
Office Add-ins