Office JavaScript API の Outlook アドイン API サブセットには、Outlook アドインで使用できるオブジェクト、メソッド、プロパティ、およびイベントが含まれています。
注:
このドキュメントは、最新の要件セット以外の要件セットのためのものです。
1.7 の新機能
メールボックス要件セット 1.7 には、 要件セット 1.6 のすべての機能が含まれています。 次の機能が追加されました。
- 予定の 定期的なパターン を取得または設定し、会議出席依頼であるメッセージの定期的なパターンを取得するプロパティを追加しました。
- 予定インスタンスが属する系列の ID を取得するプロパティを追加しました。
- 定期的な予定シリーズの開始日時と終了日時を管理する方法を追加しました。
- 作成モードで予定の開催者の値を取得するプロパティを追加しました。
- 作成モードでメッセージの送信者 (差出人値) を取得するプロパティを追加しました。
- アイテムでサポートされているイベントのイベント ハンドラーを追加および削除するメソッドを追加しました。
- 定期的なパターン、受信者、または予定時間が変更されたときに発生するイベントを追加しました。
API リスト
次の表に、メールボックス要件セット 1.7 で導入された API を示します。 メールボックス要件セット 1.7 以前でサポートされているすべての API の API リファレンス ドキュメントを表示するには、「 Outlook API」を参照してください。
| クラス | フィールド | 説明 |
|---|---|---|
| AppointmentCompose | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントのイベント ハンドラーを追加します。 |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントのイベント ハンドラーを追加します。 | |
| organizer | 指定された会議の開催者を取得します。 | |
| 繰り返し | 予定の繰り返しパターンを取得または設定します。 | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントの種類のイベント ハンドラーを削除します。 | |
| removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントの種類のイベント ハンドラーを削除します。 | |
| seriesId | インスタンスが属するシリーズの ID を取得します。 | |
| AppointmentRead | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントのイベント ハンドラーを追加します。 |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントのイベント ハンドラーを追加します。 | |
| 繰り返し | 予定の繰り返しパターンを取得します。 | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントの種類のイベント ハンドラーを削除します。 | |
| removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントの種類のイベント ハンドラーを削除します。 | |
| seriesId | インスタンスが属するシリーズの ID を取得します。 | |
| AppointmentTimeChangedEventArgs | end | 予定の終了日時を取得します。 |
| start | 予定の開始日時を取得します。 | |
| type | イベントの種類を取得します。 | |
| From | getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) | メッセージの from 値を取得します。 |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) | メッセージの from 値を取得します。 | |
| MessageCompose | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントのイベント ハンドラーを追加します。 |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントのイベント ハンドラーを追加します。 | |
| from | メッセージの送信者の電子メール アドレスを取得します。 | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントの種類のイベント ハンドラーを削除します。 | |
| removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントの種類のイベント ハンドラーを削除します。 | |
| seriesId | インスタンスが属するシリーズの ID を取得します。 | |
| MessageRead | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントのイベント ハンドラーを追加します。 |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントのイベント ハンドラーを追加します。 | |
| 繰り返し | 予定の繰り返しパターンを取得します。 | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントの種類のイベント ハンドラーを削除します。 | |
| removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | サポートされているイベントの種類のイベント ハンドラーを削除します。 | |
| seriesId | インスタンスが属するシリーズの ID を取得します。 | |
| 日 | 日 | 曜日。 |
| 金 | 金曜日 | |
| 月 | 月曜日 | |
| Sat | 土曜日 | |
| Sun | 日曜日 | |
| 木 | 木曜日 | |
| Tue | 火曜日 | |
| 水 | 水曜日 | |
| 平日 | 平日 (週末を除く): 'Mon'、'Tue'、'Wed'、[Thu'、および 'Fri'。 | |
| WeekendDay | 週末: '土' と '日'。 | |
| Month | Apr | 4 月 |
| 8 月 | 8 月 | |
| Dec | 12 月 | |
| Feb | 2 月 | |
| Jan | 1 月 | |
| Jul | 7 月 | |
| Jun | 6 月 | |
| 3 月 | 3 月 | |
| 5 月 | 5 月 | |
| Nov | 11 月 | |
| Oct | 10 月 | |
| 9 月 | 9 月 | |
| RecurrenceTimeZone | AUSCentralStandardTime | Australia Central Standard Time (オーストラリア中部標準時) |
| AUSEasternStandardTime | オーストラリア東部標準時 | |
| AfghanistanStandardTime | アフガニスタン標準時 | |
| AlaskanStandardTime | アラスカ標準時 | |
| アリューシャン標準時 | アリューシャン標準時 | |
| AltaiStandardTime | アルタイ標準時 | |
| ArabStandardTime | アラブ標準時 | |
| ArabianStandardTime | サウジアラビア標準時 | |
| ArabicStandardTime | アラビック標準時 | |
| ArgentinaStandardTime | アルゼンチン標準時 | |
| AstrakhanStandardTime | アストラハン標準時 | |
| AtlanticStandardTime | 大西洋標準時 | |
| AusCentralW_StandardTime | Australia Central West Standard Time (オーストラリア中西部標準時) | |
| AzerbaijanStandardTime | アゼルバイジャン標準時 | |
| AzoresStandardTime | アゾレス標準時 | |
| BahiaStandardTime | バイーア標準時 | |
| バングラデシュ標準時 | バングラデシュ標準時 | |
| BelarusStandardTime | ベラルーシ標準時 | |
| BougainvilleStandardTime | ブーゲンビル標準時 | |
| CanadaCentralStandardTime | カナダ中部標準時 | |
| CapeVerdeStandardTime | カーボベルデ標準時 | |
| CaucasusStandardTime | コーカサス標準時 | |
| CenAustraliaStandardTime | Central Australia Standard Time | |
| CentralAmericaStandardTime | 中央アメリカ標準時 | |
| CentralAsiaStandardTime (中央アジア標準時) | 中央アジア標準時 | |
| CentralBrazilianStandardTime | ブラジル中央標準時 | |
| CentralEuropeStandardTime | 中央ヨーロッパ標準時 | |
| CentralEuropeanStandardTime | 中央ヨーロッパ標準時 | |
| CentralPacificStandardTime (中央太平洋標準時間) | 中部太平洋標準時 | |
| CentralStandardTime | 中部標準時 | |
| CentralStandardTime_Mexico | 中部標準時 (メキシコ) | |
| ChathamIslandsStandardTime | チャタム諸島標準時 | |
| ChinaStandardTime (中国標準時間) | 中国標準時 | |
| CubaStandardTime | キューバ標準時 | |
| DatelineStandardTime | 日付変更線標準時 | |
| E_AfricaStandardTime | 東アフリカStandard時 | |
| E_AustraliaStandardTime | 東オーストラリアStandard時 | |
| E_EuropeStandardTime | East Europe Standard Time (東ヨーロッパ標準時) | |
| E_SouthAmericaStandardTime | 東南アメリカ東部 Standard Time | |
| EasterIslandStandardTime (イースター島標準時) | イースター島標準時 | |
| EasternStandardTime (東部標準時) | 東部標準時 | |
| EasternStandardTime_Mexico | 東部標準時 (メキシコ) | |
| EgyptStandardTime (エジプト標準時) | エジプト標準時 | |
| EkaterinburgStandardTime | エカテリンブルク標準時 | |
| FLEStandardTime | FLE 標準時 | |
| FijiStandardTime (フィジー標準時) | フィジー標準時 | |
| GMTStandardTime | GMT 標準時 | |
| GTBStandardTime | GTB 標準時 | |
| GeorgianStandardTime | ジョージア標準時 | |
| GreenlandStandardTime (グリーンランド標準時) | グリーンランド標準時 | |
| GreenwichStandardTime (グリニッジ標準時) | グリニッジ標準時 | |
| HaitiStandardTime | ハイチ標準時 | |
| HawaiianStandardTime | ハワイ標準時 | |
| IndiaStandardTime (インド標準時) | インド標準時 | |
| IranStandardTime | イラン標準時 | |
| IsraelStandardTime | イスラエル標準時 | |
| JordanStandardTime | ヨルダン標準時 | |
| KaliningradStandardTime | カリーニングラード標準時 | |
| KamchatkaStandardTime | カムチャッカ標準時 | |
| KoreaStandardTime (韓国標準時) | 大韓民国標準時 | |
| LibyaStandardTime | リビア標準時 | |
| LineIslandsStandardTime | ライン諸島標準時 | |
| LordHoweStandardTime | ロードハウ標準時 | |
| MagadanStandardTime | マガダン標準時 | |
| MagallanesStandardTime | マガジャネス標準時 | |
| MarquesasStandardTime | マルキーズ標準時 | |
| MauritiusStandardTime | モーリシャス標準時 | |
| MidAtlanticStandardTime | 中部大西洋標準時 | |
| MiddleEastStandardTime | 中東標準時 | |
| MontevideoStandardTime | モンテビデオ標準時 | |
| MoroccoStandardTime (モロッコ標準時) | モロッコ標準時 | |
| MountainStandardTime | 山岳部標準時 | |
| MountainStandardTime_Mexico | 山岳部標準時 (メキシコ) | |
| MyanmarStandardTime | ミャンマー標準時 | |
| N_CentralAsiaStandardTime | North Central Asia Standard Time (北中央アジア標準時) | |
| NamibiaStandardTime (ナミビア標準時間) | ナミビア標準時 | |
| NepalStandardTime (ネパール標準時) | ネパール標準時 | |
| NewZealandStandardTime (ニュージーランド標準時) | ニュージーランド標準時 | |
| NewfoundlandStandardTime (ニューファンドランド標準時) | ニューファンドランド標準時 | |
| NorfolkStandardTime | ノーフォーク標準時 | |
| NorthAsiaEastStandardTime | 北アジア東部標準時 | |
| NorthAsiaStandardTime | 北アジア標準時 | |
| 北朝鮮標準時 | 北朝鮮標準時 | |
| オムスク標準時間 | オムスク標準時 | |
| PacificSAStandardTime | 太平洋南アメリカ標準時 | |
| PacificStandardTime (太平洋標準時) | 太平洋標準時 | |
| PacificStandardTimeMexico | 太平洋標準時 (メキシコ) | |
| PakistanStandardTime | パキスタン標準時 | |
| ParaguayStandardTime (パラグアイ標準時) | パラグアイ標準時 | |
| RomanceStandardTime | ロマンス標準時 | |
| RussiaTimeZone10 | ロシアタイムゾーン 10 | |
| RussiaTimeZone11 | ロシアタイムゾーン 11 | |
| RussiaTimeZone3 | ロシアタイムゾーン 3 | |
| RussianStandardTime | ロシア標準時 | |
| SAEasternStandardTime | 南アメリカ東部標準時 | |
| SAPacificStandardTime | 南アメリカ太平洋標準時 | |
| SAWesternStandardTime | 南アメリカ西部標準時 | |
| SEAsiaStandardTime | 東南アジアStandard時間 | |
| SaintPierreStandardTime (サンピエール スタンダードタイム) | セントピエール標準時 | |
| SakhalinStandardTime | サハリン標準時 | |
| SamoaStandardTime | サモア標準時 | |
| SaratovStandardTime | サラトフ標準時 | |
| SingaporeStandardTime (シンガポール標準時) | シンガポール標準時 | |
| SouthAfricaStandardTime | 南アフリカ標準時 | |
| SriLankaStandardTime | スリランカ標準時 | |
| SudanStandardTime | Sudan Standard Time (スーダン標準時) | |
| SyriaStandardTime | シリア標準時 | |
| TaipeiStandardTime (台北市) | 台北標準時 | |
| TasmaniaStandardTime | タスマニア標準時 | |
| TocantinsStandardTime | トカンティンス標準時 | |
| TokyoStandardTime | 東京標準時 | |
| TomskStandardTime | トムスク標準時 | |
| TongaStandardTime (トンガ標準時) | トンガ標準時 | |
| TransbaikalStandardTime (トランスバイカル標準時間) | バイカル地方標準時 | |
| TurkeyStandardTime | トルコ標準時 | |
| TurksAndCaicosStandardTime | タークスカイコス標準時 | |
| USEasternStandardTime | 米国 Eastern Standard Time (米国東部標準時) | |
| USMountainStandardTime | 米国 Mountain Standard Time | |
| UTC | 世界協定時刻 (UTC) | |
| UTCMINUS02 | 協定世界時 (UTC) - 2 時間 | |
| UTCMINUS08 | 協定世界時 (UTC) - 8 時間 | |
| UTCMINUS09 | 協定世界時 (UTC) - 9 時間 | |
| UTCMINUS11 | 協定世界時 (UTC) - 11 時間 | |
| UTCPLUS12 | 協定世界時 (UTC) + 12 時間 | |
| UTCPLUS13 | 協定世界時 (UTC) + 13 時間 | |
| ウランバートルStandardTime | ウランバートル標準時 | |
| VenezuelaStandardTime | ベネズエラ標準時 | |
| VladivostokStandardTime | ウラジオストク標準時 | |
| W_AustraliaStandardTime | 西オーストラリアStandard時間 | |
| W_CentralAfricaStandardTime | West Central Africa Standard Time | |
| W_EuropeStandardTime | 西ヨーロッパStandard時間 | |
| W_MongoliaStandardTime | 西モンゴル Standard 時間 | |
| WestAsiaStandardTime (西アジア標準時間) | 西アジア標準時 | |
| WestBankStandardTime | 西岸地区標準時 | |
| WestPacificStandardTime (西太平洋標準時) | 西太平洋標準時 | |
| YakutskStandardTime | ヤクーツク標準時 | |
| RecurrenceType | 毎日 | 毎日です。 |
| 毎月 | 月単位。 | |
| 平日 | 平日。 | |
| Weekly (週単位) | 毎週です。 | |
| 年に 1 回 | 年。 | |
| WeekNumber | 第 1 | 月の最初の週 |
| 第 4 | 月の第 4 週 | |
| 末尾 | 月の最後の週 | |
| 秒 | 月の第 2 週 | |
| 第 3 | 月の第 3 週 | |
| 開催者 | getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) | 予定の開催者の値を EmailAddressDetails オブジェクトとして取得します |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) | 予定の開催者の値を EmailAddressDetails オブジェクトとして取得します | |
| RecipientsChangedEventArgs | changedRecipientFields | 受信者フィールドの変更状態を示すオブジェクトを取得します。 |
| type | イベントの種類を取得します。 | |
| RecipientsChangedFields | bcc | BCC フィールドの受信者が変更されたかどうかを取得します。 |
| cc | CC フィールドの受信者が変更されたかどうかを取得します。 | |
| optionalAttendees | オプションの出席者が変更されたかどうかを取得します。 | |
| requiredAttendees | 必要な出席者が変更されたかどうかを取得します。 | |
| resources | リソースが変更されたかどうかを取得します。 | |
| to | [宛先] フィールドの受信者が変更されたかどうかを取得します。 | |
| Recurrence | getAsync(callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void) | 予定系列の現在の定期的なオブジェクトを返します。 |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void) | 予定系列の現在の定期的なオブジェクトを返します。 | |
| recurrenceProperties | 定期的な予定シリーズのプロパティを取得または設定します。 | |
| recurrenceTimeZone | 定期的な予定シリーズのプロパティを取得または設定します。 | |
| recurrenceType | 定期的な予定シリーズの種類を取得または設定します。 | |
| seriesTime | SeriesTime オブジェクトを使用すると、定期的な予定シリーズの開始日と終了日を管理でき、 | |
| setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult<void>) => void) | 予定系列の定期的なパターンを設定します。 | |
| setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | 予定系列の定期的なパターンを設定します。 | |
| RecurrenceChangedEventArgs | 繰り返し | 更新された定期的なオブジェクトを取得します。 |
| type | イベントの種類を取得します。 | |
| RecurrenceProperties | dayOfMonth | 月の日付を表します。 |
| dayOfWeek | 曜日または曜日の種類 (例: 土曜日と平日) を表します。 | |
| のうち | この定期的な日数を表します。 | |
| firstDayOfWeek | 選択した週の最初の曜日を表します。それ以外の場合は、現在のユーザーの設定の値が既定値になります。 | |
| interval | 同じ定期的な系列のインスタンス間の期間を表します。 | |
| month | 月を表します。 | |
| weekNumber | 選択した月の週番号を表します (例: 月の最初の週の 'first')。 | |
| RecurrenceTimeZone | name | 定期的なタイム ゾーンの名前を表します。 |
| オフセット | 一連の会議が開始された日付のローカル タイム ゾーンと UTC の分単位の差を表す整数値。 | |
| SeriesTime | getDuration() | 定期的な予定シリーズの通常のインスタンスの期間を分単位で取得します。 |
| getEndDate() | 次の定期的なパターンの終了日を取得します | |
| getEndTime() | ユーザーまたはタイム ゾーンのいずれかのタイム ゾーンで定期的なパターンの通常の予定または会議出席依頼インスタンスの終了時刻を取得します。 | |
| getStartDate() | 次の定期的なパターンの開始日を取得します | |
| getStartTime() | ユーザー/アドインが設定したタイム ゾーンにおける、定期的なパターンの通常の予定インスタンスの開始時刻を取得します。 | |
| setDuration(minutes: number) | すべての予定の期間を定期的なパターンで設定します。 | |
| setEndDate(date: string) | 定期的な予定シリーズの終了日を設定します。 | |
| setEndDate(year: number, month: number, day: number) | 定期的な予定シリーズの終了日を設定します。 | |
| setStartDate(date:string) | 定期的な予定シリーズの開始日を設定します。 | |
| setStartDate(year:number, month:number, day:number) | 定期的な予定シリーズの開始日を設定します。 | |
| setStartTime(hours: number, minutes: number) | 定期的なパターンが設定されているタイム ゾーンにおける、定期的な予定系列のすべてのインスタンスの開始時刻を設定します | |
| setStartTime(time: string) | 定期的なパターンが設定されているタイム ゾーンにおける、定期的な予定系列のすべてのインスタンスの開始時刻を設定します |
イベント
次の表に、要件セット 1.7 で導入された イベント を示します。
addHandlerAsync メソッドと removeHandlerAsync メソッドを使用して処理できるサポートされているすべてのイベントの一覧については、「Office.EventType」を参照してください。
| イベント | 説明 | オブジェクト |
|---|---|---|
| AppointmentTimeChanged | 選択した予定または系列の日付または時刻が変更されました。 | アイテム |
| RecipientsChanged | 選択したアイテムまたは予定の場所の受信者リストが変更されました。 | アイテム |
| RecurrenceChanged | 選択した会議系列の定期的なパターンが変更されました。 | アイテム |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins