次の方法で共有


Office.DisplayedSubject interface

注意

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

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

注釈

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

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

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

メソッド

setAsync(data, options, callback)

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

setAsync(data, callback)

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

メソッドの詳細

setAsync(data, options, callback)

注意

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

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

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

パラメーター

data

string

メッセージの件名に一時的に表示される文字列。 文字列の最大長は 255 文字です。

options
Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback

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

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

戻り値

void

注釈

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

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

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

重要:

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

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

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

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

setAsync(data, callback)

注意

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

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

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

パラメーター

data

string

メッセージの件名に一時的に表示される文字列。 文字列の最大長は 255 文字です。

callback

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

省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター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 subject field 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 subjectText = $("#subject-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.subject.setAsync(subjectText, (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 subject field.");
});