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

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

注:

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

1.3 の新機能

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

  • 関数コマンドのサポートを追加しました。 詳細については、「 アドイン コマンド」を参照してください。

  • 作成中のアイテムを下書きとして保存する方法を追加しました。

  • 作成中のアイテムを閉じるメソッドを追加しました。

  • メッセージまたは予定の本文全体を取得または設定するメソッドを追加しました。 詳細については、「 Outlook でメッセージまたは予定の本文を取得または設定する」を参照してください。

  • アイテム ID を EWS 形式と REST 形式の間で変換するメソッドを追加しました。

    重要

    従来の Exchange Online ユーザー ID トークンとコールバック トークンはサポートされなくなり、すべての Microsoft 365 テナントでオフになっています。 Outlook アドインで委任されたユーザー アクセスまたはユーザー ID が必要な場合は、 MSAL (Microsoft 認証ライブラリ) と入れ子になったアプリ認証 (NAA) の使用をお勧めします。 Exchange ユーザー ID トークンは、Exchange オンプレミスで引き続きサポートされます。

  • アイテムに対して 通知メッセージ を追加、取得、置換、削除するプロパティとメソッドを追加しました。

API リスト

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

クラス フィールド 説明
AppointmentCompose close() 作成中の現在の項目を閉じます。
notificationMessages アイテムの通知メッセージを取得します。
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) 項目を非同期的に保存します。
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) 項目を非同期的に保存します。
AppointmentRead notificationMessages アイテムの通知メッセージを取得します。
Body getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult<string>) => void) 現在の本文全体を、 coercionType で指定された形式で返します。
getAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<string>) => void) 現在の本文全体を、 coercionType で指定された形式で返します。
setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) 本文全体を指定されたテキストに置換します。
setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<void>) => void) 本文全体を指定されたテキストに置換します。
メールボックス convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion | string) サポートされている ID を Exchange Web サービス (EWS) 形式に変換します。
convertToRestId(id: string, restVersion: MailboxEnums.RestVersion | string) サポートされている ID を REST 形式に変換します。
MessageCompose close() 作成中の現在の項目を閉じます。
notificationMessages アイテムの通知メッセージを取得します。
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) 現在のメッセージを下書きとして非同期に保存します。
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) 現在のメッセージを下書きとして非同期に保存します。
MessageRead notificationMessages アイテムの通知メッセージを取得します。
NotificationMessageDetails icon マニフェストで定義されているカスタム アイコンへの参照。
key 通知メッセージの識別子。
message 通知メッセージのテキスト。
persistent メッセージを永続化するかどうかを指定します。
type メッセージの ItemNotificationMessageType を指定します。
NotificationMessages addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテムに通知を追加します。
addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテムに通知を追加します。
getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) アイテムのすべてのキーとメッセージを返します。
getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) アイテムのすべてのキーとメッセージを返します。
removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテムの通知メッセージを削除します。
removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテムの通知メッセージを削除します。
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) 指定のキーが含まれる通知メッセージを別のメッセージに置換します。
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 指定のキーが含まれる通知メッセージを別のメッセージに置換します。
ItemNotificationMessageType ErrorMessage 通知メッセージはエラー メッセージです。
InformationalMessage 通知メッセージは情報メッセージです。
ProgressIndicator 通知メッセージは進行状況インジケーターです。
RestVersion ベータ版 ベータ版。
v1_0 バージョン 1.0。
v2_0 バージョン 2.0。

関連項目

  • Last updated on