Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Die Outlook-Add-In-API-Teilmenge der Office JavaScript-API enthält Objekte, Methoden, Eigenschaften und Ereignisse, die Sie in einem Outlook-Add-In verwenden können.
Hinweis
Diese Dokumentation bezieht sich auf einen anderen Anforderungssatz als den aktuellen.
Neuigkeiten in 1.7
Postfachanforderungssatz 1.7 enthält alle Funktionen des Anforderungssatzes 1.6. Zusätzlich wurden die folgenden Funktionen implementiert.
- Eigenschaft wurde hinzugefügt, um das Serienmuster eines Termins abzurufen oder festzulegen und das Serienmuster von Nachrichten abzurufen, bei denen es sich um Besprechungsanfragen handelt.
- Eigenschaft hinzugefügt, um die ID der Serie abzurufen, zu der eine Termin-instance gehört.
- Es wurden Methoden zum Verwalten des Start- und Enddatums sowie der Start- und Endzeit einer Terminserie hinzugefügt.
- Eigenschaft hinzugefügt, um den Organisatorwert eines Termins im Kompositionsmodus abzurufen.
- Eigenschaft hinzugefügt, um den Absender (Aus Wert) einer Nachricht im Erstellungsmodus abzurufen.
- Methoden zum Hinzufügen und Entfernen von Ereignishandlern für unterstützte Ereignisse für Elemente hinzugefügt.
- Es wurden Ereignisse hinzugefügt, die auftreten, wenn das Serienmuster, die Empfänger oder die Terminzeit geändert werden.
API-Liste
In der folgenden Tabelle sind die APIs aufgeführt, die im Postfach-Anforderungssatz 1.7 eingeführt wurden. Die API-Referenzdokumentation für alle APIs, die vom Postfachanforderungssatz 1.7 oder früher unterstützt werden, finden Sie unter Outlook-APIs.
| Klasse | Felder | Beschreibung |
|---|---|---|
| AppointmentCompose | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. | |
| organizer | Ruft den Organisator für die angegebene Besprechung ab. | |
| Wiederholung | Ruft das Serienmuster eines Termins ab oder legt es fest. | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Entfernt die Ereignishandler für einen unterstützten Ereignistyp. | |
| removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Entfernt die Ereignishandler für einen unterstützten Ereignistyp. | |
| seriesId | Ruft die ID der Serie ab, zu der eine Instance gehört. | |
| AppointmentRead | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. | |
| Wiederholung | Ruft das Serienmuster eines Termins ab. | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Entfernt die Ereignishandler für einen unterstützten Ereignistyp. | |
| removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Entfernt die Ereignishandler für einen unterstützten Ereignistyp. | |
| seriesId | Ruft die ID der Serie ab, zu der eine Instance gehört. | |
| AppointmentTimeChangedEventArgs | end | Ruft das Enddatum und die Uhrzeit des Termins ab. |
| start | Ruft das Startdatum und die Uhrzeit des Termins ab. | |
| type | Ruft den Typ des Ereignisses ab. | |
| From | getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) | Ruft den Absenderwert einer Nachricht ab. |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) | Ruft den Absenderwert einer Nachricht ab. | |
| MessageCompose | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. | |
| Von | Ruft die E-Mail-Adresse des Absenders einer Nachricht ab. | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Entfernt die Ereignishandler für einen unterstützten Ereignistyp. | |
| removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Entfernt die Ereignishandler für einen unterstützten Ereignistyp. | |
| seriesId | Ruft die ID der Serie ab, zu der eine Instance gehört. | |
| MessageRead | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. | |
| Wiederholung | Ruft das Serienmuster eines Termins ab. | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Entfernt die Ereignishandler für einen unterstützten Ereignistyp. | |
| removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Entfernt die Ereignishandler für einen unterstützten Ereignistyp. | |
| seriesId | Ruft die ID der Serie ab, zu der eine Instance gehört. | |
| Tage | Tag | Wochentag. |
| Fr | Freitag | |
| Mo. | Montag | |
| Sa | Samstag | |
| Sonne | Sonntag | |
| Do. | Donnerstag | |
| Di | Dienstag | |
| Mi | Mittwoch | |
| Wochentag | Wochentag (ausgenommen Wochenendtage): Mo, Di, Mi, Do und Fr. | |
| WeekendDay | Wochenendtag: "Sa" und "So". | |
| Month | Apr | April |
| Aug (Englisch) | August | |
| Dez | Dezember | |
| Feb | Februar | |
| Jan | Januar | |
| Jul | Juli | |
| Jun | Juni | |
| Mär | März | |
| Mai | Mai | |
| Nov | November | |
| Okt | Oktober | |
| Sep | September | |
| RecurrenceTimeZone | AUSCentralStandardTime | Australien, Mitte Standard Time |
| AUSEasternStandardTime | AUS Eastern Standard Time | |
| AfghanistanStandardTime | Afghanistan Standard Time | |
| AlaskanStandardTime | Alaskan Standard Time | |
| AleutianStandardTime | Aleuten Standard Time | |
| AltaiStandardTime | Altai Standard Time | |
| ArabStandardTime | Arabische Standardzeit | |
| ArabianStandardTime | Arabian Standard Time | |
| ArabicStandardTime | Arabische Standardzeit | |
| ArgentinaStandardTime | Argentinien Standard Time | |
| AstrakhanStandardTime | Astrachan Standard Time | |
| AtlanticStandardTime | Atlantic Standard Time | |
| AusCentralW_StandardTime | Australien, Mitte, Westen Standard Time | |
| AserbaidschanStandardTime | Aserbaidschan Standard Time | |
| AzoresStandardTime | Azoren Standard Time | |
| BahiaStandardTime | Bahia Standard Time | |
| BangladeshStandardTime | Bangladesch Standard Time | |
| BelarusStandardTime | Belarus Standard Time | |
| BougainvilleStandardTime | Bougainville Standard Time | |
| CanadaCentralStandardTime | Kanada, Mitte Standard Time | |
| CapeVerdeStandardTime | Kap Verde Standard Time | |
| KaukasusStandardTime | Kaukasus Standard Time | |
| CenAustraliaStandardTime | Zentralaustralien Standard Time | |
| CentralAmericaStandardTime | Mittelamerika Standard Time | |
| CentralAsiaStandardTime | Zentralasien Standard Time | |
| CentralBrazilianStandardTime | Zentralbrasilien Standard Time | |
| CentralEuropeStandardTime | Central Europe Standard Time | |
| CentralEuropeanStandardTime | Mitteleuropäische Standardzeit | |
| CentralPacificStandardTime | Central Pacific Standard Time | |
| CentralStandardTime | Central Standard Time | |
| CentralStandardTime_Mexico | Central Standard Time (Mexiko) | |
| ChathamIslandsStandardTime | Chatham-Inseln Standard Time | |
| ChinaStandardTime | China Standard Time | |
| CubaStandardTime | Kuba Standard Time | |
| DatelineStandardTime | Dateline Standard Time | |
| E_AfricaStandardTime | Ostafrika Standard Time | |
| E_AustraliaStandardTime | East Australia Standard Time | |
| E_EuropeStandardTime | Osteuropa Standard Time | |
| E_SouthAmericaStandardTime | East South America Standard Time | |
| EasterIslandStandardTime | Osterinsel Standard Time | |
| EasternStandardTime | Eastern Standard Time | |
| EasternStandardTime_Mexico | Eastern Standard Time (Mexiko) | |
| EgyptStandardTime | Ägypten Standard Time | |
| JekaterinburgStandardTime | Jekaterinburg Standard Time | |
| FLEStandardTime | FLE Standard Time | |
| FijiStandardTime | Fidschi Standard Time | |
| GMTStandardTime | GMT Standard Time | |
| GTBStandardTime | Osteuropa Standard Time | |
| GeorgianStandardTime | Georgische Standardzeit | |
| GreenlandStandardTime | Grönland Standard Time | |
| GreenwichStandardTime | Greenwich Standard Time | |
| HaitiStandardTime | Haiti Standard Time | |
| HawaiianStandardTime | Hawaiianische Standard Time | |
| IndiaStandardTime | Indien Standard Time | |
| IranStandardTime | Iran Standard Time | |
| IsraelStandardTime | Israel Standard Time | |
| JordanStandardTime | Jordanien Standard Time | |
| KaliningradStandardTime | Kaliningrad Standard Time | |
| KamchatkaStandardTime | Kamchatka Standard Time | |
| KoreaStandardTime | Korea Standard Time | |
| LibyaStandardTime | Libyen Standard Time | |
| LineIslandsStandardTime | Linieninseln Standard Time | |
| LordHoweStandardTime | Lord Howe Standard Time | |
| MagadanStandardTime | Magadan Standard Time | |
| MagallanesStandardTime | Magallanes Standard Time | |
| MarquesasStandardTime | Marquesas Standard Time | |
| MauritiusStandardTime | Mauritius Standard Time | |
| MidAtlanticStandardTime | Mid-Atlantic Standard Zeit | |
| MiddleEastStandardTime | Mittlerer Osten Standard Time | |
| MontevideoStandardTime | Montevideo Standard Time | |
| MoroccoStandardTime | Marokko Standard Time | |
| MountainStandardTime | Mountain Standard Time | |
| MountainStandardTime_Mexico | Mountain Standard Time (Mexiko) | |
| MyanmarStandardTime | Myanmar Standard Time | |
| N_CentralAsiaStandardTime | N. Zentralasien Standard Time | |
| NamibiaStandardTime | Namibia Standard Time | |
| NepalStandardTime | Nepal Standard Time | |
| NeuseelandStandardTime | Neuseeland Standard Time | |
| NeufundlandStandardzeit | Neufundland Standard Time | |
| NorfolkStandardTime | Norfolk Standard Time | |
| NorthAsiaEastStandardTime | Nordostasien Standard Time | |
| NorthAsiaStandardTime | Nordasien Standard Time | |
| NorthKoreaStandardTime | Nordkorea Standard Time | |
| OmskStandardTime | Omsk Standard Time | |
| PacificSAStandardTime | Pazifik SA Standard Time | |
| PacificStandardTime | Pacific Standard Time | |
| PacificStandardTimeMexico | Pacific Standard Time (Mexiko) | |
| PakistanStandardTime | Pakistan Standard Time | |
| ParaguayStandardTime | Paraguay Standard Time | |
| RomanceStandardTime | Romance Standard Time | |
| RussiaTimeZone10 | Russland Zeitzone 10 | |
| RussiaTimeZone11 | Russland Zeitzone 11 | |
| RussiaTimeZone3 | Russland Zeitzone 3 | |
| RussianStandardTime | Russische Standard Time | |
| SAEasternStandardTime | Östl. Südamerika Standard Time | |
| SAPacificStandardTime | Westl. Südamerika Standard Time | |
| SAWesternStandardTime | Westl. Südamerika Standard Time | |
| SEAsiaStandardTime | Südostasien Standard Time | |
| SaintPierreStandardTime | Saint Pierre Standard Time | |
| SachalinStandardZeit | Sachalin Standard Time | |
| SamoaStandardTime | Samoa Standard Time | |
| SaratovStandardTime | Saratow Standard Time | |
| SingaporeStandardTime | Singapur Standard Time | |
| SouthAfricaStandardTime | Südafrika Standard Time | |
| SriLankaStandardTime | Sri Lanka Standard Time | |
| SudanStandardTime | Sudan Standard Time | |
| SyrienStandardTime | Syrien Standard Time | |
| TaipeiStandardTime | Taipeh Standard Time | |
| TasmanienStandardTime | Tasmanien Standard Time | |
| TocantinsStandardTime | Tocantins Standard Time | |
| TokyoStandardTime | Tokyo Standard Time | |
| TomskStandardTime | Tomsk Standard Time | |
| TongaStandardTime | Tonga Standard Time | |
| TransbaikalStandardTime | Transbaikal Standard Time | |
| TurkeyStandardTime | Türkei Standard Time | |
| TurksAndCaicosStandardTime | Turks- und Caicosinseln-Standard Time | |
| USEasternStandardTime | USA Eastern Standard Time | |
| USMountainStandardTime | USA Mountain Standard Time | |
| UTC | Koordinierte Weltzeit (UTC) | |
| UTCMINUS02 | Koordinierte Weltzeit (UTC): 2 Stunden | |
| UTCMINUS08 | Koordinierte Weltzeit (UTC) – 8 Stunden | |
| UTCMINUS09 | Koordinierte Weltzeit (UTC) – 9 Stunden | |
| UTCMINUS11 | Koordinierte Weltzeit (UTC) – 11 Stunden | |
| UTCPLUS12 | Koordinierte Weltzeit (UTC) + 12 Stunden | |
| UTCPLUS13 | Koordinierte Weltzeit (UTC) + 13 Stunden | |
| UlaanbaatarStandardTime | Ulan Bator Standard Time | |
| VenezuelaStandardTime | Venezuela Standard Time | |
| WladiwostokStandardTime | Wladiwostok Standard Time | |
| W_AustraliaStandardTime | West Australia Standard Time | |
| W_CentralAfricaStandardTime | West-Zentralafrika Standard Time | |
| W_EuropeStandardTime | Europa, Westen Standard Time | |
| W_MongoliaStandardTime | Westmongolei Standard Time | |
| WestAsiaStandardTime | Westasien Standard Time | |
| WestBankStandardTime | West Bank Standard Time | |
| WestPacificStandardTime | Westpazifik Standard Time | |
| JakutskStandardTime | Jakutsk Standard Time | |
| RecurrenceType | Täglich | Täglich. |
| Monatlich | Monatlich. | |
| Wochentag | Wochentag. | |
| Wöchentlich | Wöchentlich. | |
| Jährlich | Jährlich. | |
| WeekNumber | Erster | Erste Woche des Monats |
| Vier | Vierte Woche des Monats | |
| Letzte | Letzte Woche des Monats | |
| Zweiter | Zweite Woche des Monats | |
| Dritter | Dritte Woche des Monats | |
| Organisator | getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) | Ruft den Organisatorwert eines Termins als EmailAddressDetails-Objekt ab. |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) | Ruft den Organisatorwert eines Termins als EmailAddressDetails-Objekt ab. | |
| RecipientsChangedEventArgs | changedRecipientFields | Ruft ein Objekt ab, das den Änderungsstatus von Empfängerfeldern angibt. |
| type | Ruft den Typ des Ereignisses ab. | |
| RecipientsChangedFields | bcc | Ruft ab, ob Empfänger im Feld "Bcc" geändert wurden. |
| cc | Ruft ab, ob Empfänger im Feld "Cc" geändert wurden. | |
| optionalAttendees | Ruft ab, ob optionale Teilnehmer geändert wurden. | |
| requiredAttendees | Ruft ab, ob erforderliche Teilnehmer geändert wurden. | |
| Ressourcen | Ruft ab, ob Ressourcen geändert wurden. | |
| to | Ruft ab, ob Empfänger im Feld "An" geändert wurden. | |
| Serie | getAsync(callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void) | Gibt das aktuelle Serienobjekt einer Terminserie zurück. |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void) | Gibt das aktuelle Serienobjekt einer Terminserie zurück. | |
| 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 verwalten und | |
| setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Legt das Serienmuster einer Terminserie fest. | |
| setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Legt das Serienmuster einer Terminserie fest. | |
| RecurrenceChangedEventArgs | Wiederholung | Ruft das aktualisierte Serienobjekt ab. |
| type | Ruft den Typ des Ereignisses ab. | |
| RecurrenceProperties | dayOfMonth | Stellt den Tag innerhalb des Monats dar. |
| dayOfWeek | Stellt den Wochentag oder die Art des Tages dar, z. B. Wochenendtag im Vergleich zu Wochentag. | |
| Tage | Stellt die Anzahl der Tage für diese Wiederholung dar. | |
| firstDayOfWeek | Steht für den ausgewählten ersten Tag der Woche, andernfalls ist der Standardwert der Wert in den Einstellungen des aktuellen Benutzers. | |
| Intervall | Stellt den Zeitraum zwischen Instanzen derselben wiederkehrenden Serie dar. | |
| Monat | Steht für den Monat. | |
| weekNumber | Stellt die Wochennummer im ausgewählten Monat dar, z. B. "erste" für die erste Woche des Monats. | |
| RecurrenceTimeZone | name | Stellt den Namen der Zeitzone der Serie dar. |
| Offset versetzen | Ganzzahliger Wert, der die Differenz in Minuten zwischen der lokalen Zeitzone und UTC zum Zeitpunkt des Beginns der Besprechungsserie darstellt. | |
| SeriesTime | getDuration() | Ruft die Dauer einer üblichen Instance in einer Terminserie in Minuten ab. |
| getEndDate() | Ruft das Enddatum eines Serienmusters wie folgt ab | |
| getEndTime() | Ruft die Endzeit einer üblichen Termin- oder Besprechungsanfrage-instance eines Serienmusters ab, unabhängig von der Zeitzone, die der Benutzer oder | |
| getStartDate() | Ruft das Startdatum eines Serienmusters wie folgt ab | |
| getStartTime() | Ruft die Startzeit einer üblichen Termin-instance eines Serienmusters ab, unabhängig von der Zeitzone, die der Benutzer/das Add-In festgelegt hat. | |
| setDuration(minutes: number) | Legt die Dauer aller Termine in einem Serienmuster fest. | |
| setEndDate(date: string) | Legt das Enddatum einer Terminserie fest. | |
| setEndDate(year: number, month: number, day: number) | Legt das Enddatum einer Terminserie fest. | |
| setStartDate(date:string) | Legt das Startdatum einer Terminserie fest. | |
| setStartDate(year:number, month:number, day:number) | Legt das Startdatum einer Terminserie fest. | |
| setStartTime(hours: number, minutes: number) | Legt die Startzeit aller Instanzen einer Terminserie in der Zeitzone fest, in der das Muster der Serie festgelegt ist | |
| setStartTime(time: string) | Legt die Startzeit aller Instanzen einer Terminserie in der Zeitzone fest, in der das Muster der Serie festgelegt ist |
Ereignisse
In der folgenden Tabelle sind die in Anforderungssatz 1.7 eingeführten Ereignisse aufgeführt. Eine Liste aller unterstützten Ereignisse, die mit der addHandlerAsync and-Methode removeHandlerAsync behandelt werden können, finden Sie unter Office.EventType.
| Ereignis | Beschreibung | Object |
|---|---|---|
| AppointmentTimeChanged | Das Datum oder die Uhrzeit des ausgewählten Termins oder der Serie wurde geändert. | Element |
| RecipientsChanged | Die Empfängerliste des ausgewählten Elements oder Terminorts wurde geändert. | Element |
| RecurrenceChanged | Das Serienmuster der ausgewählten Besprechungsserie wurde geändert. | Element |
Siehe auch
Office Add-ins