Outlook アドインAPI プレビュー要件セット

Office JavaScript API の Outlook アドイン API サブセットには、Outlook アドインで使用できるオブジェクト、メソッド、プロパティ、イベントが含まれています。

プレビュー API は変更される可能性があり、運用環境での使用を目的としたものではありません。 試用はテスト環境と開発環境に限定することをお勧めします。 運用環境やビジネス クリティカルなドキュメント内でプレビュー API を使用しないでください。

プレビュー API を使用するには:

  • Office.js コンテンツ配信ネットワーク (CDN) から Office JavaScript API ライブラリのプレビュー バージョンを使用する必要があります。 TypeScript コンパイルおよび IntelliSense の 型定義ファイルは CDN で見つかり、DefinitelyTyped にあります。 これらの種類は、 npm install --save-dev @types/office-js-preview でインストールできます (以前にインストールした場合は、 @types/office-js の種類を必ず削除してください)。

  • Outlook on Windows および Mac で最新の Office ビルドにアクセスするには、 Microsoft 365 Insider プログラム に参加することが必要になる場合があります。

  • Microsoft 365 テナントでターゲット リリース オプションを構成して、Outlook on the webの機能をプレビューする必要がある場合があります。 詳細については、「Standardまたはターゲット リリース オプションを設定する」の「対象リリース」セクションを参照してください。

プレビュー要件セットには、 要件セット 1.15 のすべての機能が含まれています。

重要

このドキュメントは、 プレビュー要件セット用です。 この要件セットはまだ完全に実装されていないため、クライアントはサポートを正確に報告しません。 アドイン マニフェストでは、この要件セットを指定しないでください。

プレビューの機能

次の機能はプレビュー段階です。

  • event.completed メソッドの errorMessageMarkdown プロパティのサポートを Outlook on Mac のスマート アラート アドインに拡張しました。
  • 予定が終日イベントであるかどうかを取得または設定するプロパティを追加しました。
  • 特定の添付ファイルの種類またはカスタム インターネット ヘッダーが含まれている場合に、読み取りモードでメッセージに 対してイベント ベースのアドイン をアクティブ化するイベントを追加しました。
  • 読み取りモードで表示される本文または件名を一時的に設定するプロパティとオブジェクトを追加しました。

API リスト

次の表に、現在プレビュー中の Outlook JavaScript API の一覧を示します。 すべての Outlook JavaScript API (プレビュー API と以前にリリースされた API を含む) の API リファレンス ドキュメントを表示するには、「 Outlook API」を参照してください。

クラス フィールド 説明
AppointmentCompose isAllDayEvent 予定の Office.IsAllDayEvent プロパティを取得または設定します。
AppointmentRead isAllDayEvent イベントが終日かどうかを示すブール値を返します。
Display body 読み取りモードでメッセージの本文に表示されるコンテンツを一時的に設定するオブジェクトを取得します。
subject 読み取りモードでメッセージの件名に表示されるコンテンツを一時的に設定するオブジェクトを取得します。
DisplayedBody setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) 読み取りモードでメッセージの本文に表示されるコンテンツを一時的に設定します。
setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 読み取りモードでメッセージの本文に表示されるコンテンツを一時的に設定します。
DisplayedSubject setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) 読み取りモードでメッセージの件名に表示されるコンテンツを一時的に設定します。
setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 読み取りモードでメッセージの件名に表示されるコンテンツを一時的に設定します。
IsAllDayEvent getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) イベントが終日かどうかを示すブール値を取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) イベントが終日かどうかを示すブール値を取得します。
setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の終日イベントの状態を設定します。
setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の終日イベントの状態を設定します。
MessageRead 表示 読み取りモードでメッセージの本文または件名に表示されるコンテンツを一時的に設定するオブジェクトを取得します。

関連項目

  • Last updated on