Office.DisplayedBody interface

  • リファレンス
パッケージ:
outlook

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

読み取りモードでメッセージの本文に表示されるコンテンツを一時的に設定するメソッドを提供します。

注釈

[ API セット: メールボックス プレビュー ]

最小アクセス許可レベル: 項目の読み取り/書き込み

適用される Outlook モード: メッセージの読み取り

メソッド

setAsync(data, options, callback)

読み取りモードでメッセージの本文に表示されるコンテンツを一時的に設定します。 ユーザーが別のメッセージに切り替わるか、現在のメッセージのウィンドウを閉じるまで、設定されたコンテンツは表示されたままです。
setAsync(data, callback)

読み取りモードでメッセージの本文に表示されるコンテンツを一時的に設定します。 設定されたコンテンツは、ユーザーが別のメッセージに切り替わるか、現在のメッセージのウィンドウを閉じるまで表示されます。

メソッドの詳細

setAsync(data, options, callback)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

読み取りモードでメッセージの本文に表示されるコンテンツを一時的に設定します。 ユーザーが別のメッセージに切り替わるか、現在のメッセージのウィンドウを閉じるまで、設定されたコンテンツは表示されたままです。

setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

data

string

メッセージの本文に一時的に表示される文字列。 文字列の最大長は 1,000,000 文字です。

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。 coercionType: 一時的に表示されるデータの形式。 パラメーター内の文字列は、この形式に変換されます。

callback

(asyncResult: Office.AsyncResult<void>) => void

オプション。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。 検出されたすべてのエラーは asyncResult.error プロパティに表示されます。

戻り値

void

注釈

[ API セット: メールボックス プレビュー ]

最小アクセス許可レベル: 項目の読み取り/書き込み

適用される Outlook モード: メッセージの読み取り

推奨: Office.context.mailbox.item.body.getTypeAsync を呼び出し、返された値をパラメーターに options.coercionType 渡します。

重要:

  • 実装 setAsync する複数のアドインが同時に実行される場合、操作を完了 setAsync した最後のアドインによって設定されたコンテンツが本文に表示されます。

  • メソッドによって設定された setAsync コンテンツは、ユーザーがアイテムを表示している間にのみ表示されます。 これは Outlook にキャッシュされておらず、他の Outlook クライアントと同期されません。

  • を呼び出 setAsyncした後にメッセージを保存すると、メッセージ本文の元の内容が保存されたアイテムに表示されます。

  • メソッドは setAsync 、選択した複数のメッセージではサポートされていません。

setAsync(data, callback)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

読み取りモードでメッセージの本文に表示されるコンテンツを一時的に設定します。 設定されたコンテンツは、ユーザーが別のメッセージに切り替わるか、現在のメッセージのウィンドウを閉じるまで表示されます。

setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

data

string

メッセージの本文に一時的に表示される文字列。 文字列の最大長は 1,000,000 文字です。

callback

(asyncResult: Office.AsyncResult<void>) => void

オプション。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。 検出されたすべてのエラーは asyncResult.error プロパティに表示されます。

戻り値

void

注釈

[ API セット: メールボックス プレビュー ]

最小アクセス許可レベル: 項目の読み取り/書き込み

適用される Outlook モード: メッセージの読み取り

重要:

  • 実装 setAsync する複数のアドインが同時に実行される場合、操作を完了 setAsync した最後のアドインによって設定されたコンテンツが本文に表示されます。

  • メソッドによって設定された setAsync コンテンツは、ユーザーがアイテムを表示している間にのみ表示されます。 これは Outlook にキャッシュされておらず、他の Outlook クライアントと同期されません。

  • を呼び出 setAsyncした後にメッセージを保存すると、メッセージ本文の元の内容が保存されたアイテムに表示されます。

  • メソッドは setAsync 、選択した複数のメッセージではサポートされていません。

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the body of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const bodyText = $("#body-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.body.setAsync(bodyText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the body.");
});