Outlook アドイン API 要件セット 1.5

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

注:

このドキュメントは、最新の要件セット以外の要件セットのためのものです。

1.5 の新機能

メールボックス要件セット 1.5 には、 要件セット 1.4 のすべての機能が含まれています。 次の機能が追加されました。

  • ピン留め可能な作業ウィンドウのサポートが追加されました。
  • REST API の呼び出しのサポートが追加されました。

    重要

    Outlook REST v2.0 およびベータ エンドポイントは非推奨です。 代わりに Microsoft Graph REST API を使用してください。

  • 添付ファイルをインラインとしてマークするサポートが追加されました。
  • タスク ウィンドウまたはダイアログをプログラムで閉じるためのサポートが追加されました。
  • Office.context.診断プロパティとその関連オブジェクトのサポートが追加されました。
  • アドインのタスク ウィンドウが固定されているときに Outlook メール アイテムが表示対象として選択されたタイミングを特定するイベントが追加されました。

API リスト

次の表に、メールボックス要件セット 1.5 で導入された API を示します。 メールボックス要件セット 1.5 以前でサポートされているすべての API の API リファレンス ドキュメントを表示するには、「 Outlook API」を参照してください。

クラス フィールド 説明
DragAndDropEventArgs dragAndDropEventData アドインの作業ウィンドウ内でのマウス ポインターの位置と、作業ウィンドウにドラッグ アンド ドロップされているメッセージや添付ファイルに関する詳細を取得します。
type イベントの種類を取得します。
DragoverEventData pageX 水平位置を表すマウス ポインターの x 座標をピクセル単位で取得します。
pageY 垂直位置を表すマウス ポインターの y 座標をピクセル単位で取得します。
taskPaneX 水平位置を表すマウス ポインターの x 座標をピクセル単位で取得します。
taskPaneY 垂直位置を表すマウス ポインターの y 座標をピクセル単位で取得します。
type ドラッグ アンド ドロップ イベントの種類を取得します。
DropEventData dataTransfer アドインの作業ウィンドウにドラッグ アンド ドロップされているメッセージまたは添付ファイルを取得します。
pageX 水平位置を表すマウス ポインターの x 座標をピクセル単位で取得します。
pageY 垂直位置を表すマウス ポインターの y 座標をピクセル単位で取得します。
taskPaneX 水平位置を表すマウス ポインターの x 座標をピクセル単位で取得します。
taskPaneY 垂直位置を表すマウス ポインターの y 座標をピクセル単位で取得します。
type ドラッグ アンド ドロップ イベントの種類を取得します。
DroppedItemDetails fileContent ドラッグ アンド ドロップされているファイルの内容を取得します。
name ドラッグ アンド ドロップされているファイルの名前を取得します。
type ドラッグ アンド ドロップされるファイルの種類を取得します。
DroppedItems ファイル アドインの作業ウィンドウにドラッグ アンド ドロップされているメッセージまたは添付ファイルの配列を取得します。
メールボックス 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) サポートされているイベントのイベント ハンドラーを追加します。
getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<string>) => void) REST API または Exchange Web サービス (EWS) の呼び出しに使用されるトークンを含む文字列を取得します。
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) サポートされているイベントの種類のイベント ハンドラーを削除します。
restUrl この電子メール アカウントの REST エンドポイントの URL を取得します。

イベント

次の表に、要件セット 1.5 で導入された イベント を示します。 addHandlerAsync メソッドと removeHandlerAsync メソッドを使用して処理できるサポートされているすべてのイベントの一覧については、「Office.EventType」を参照してください。

イベント 説明 オブジェクト
ItemChanged アドインの作業ウィンドウが固定されている間に、別の Outlook アイテムが選択されて表示される。 Mailbox

関連項目

  • Last updated on