Office.SessionData interface

リファレンス

パッケージ:: outlook

項目のセッションデータを管理するメソッドを提供します。

セッションデータは、1 つのメールアイテムに固有です。同じアドインを使用してデータを設定または取得しても、複数のアイテム間で共有されることはありません。

注釈

[ API セット: メールボックス 1.11 ]

最小アクセス許可レベル: 読み取り項目

適用される Outlook モード: Compose

重要: メールアイテムごとに、SessionData オブジェクト全体はアドインあたり 50,000 文字に制限されます。

メソッド

clearAsync(options, callback)	すべてのセッションデータキーと値のペアをクリアします。
clearAsync(callback)	すべてのセッションデータキーと値のペアをクリアします。
getAllAsync(callback)	すべてのセッションデータキーと値のペアを取得します。
getAsync(name, callback)	指定したキーのセッションデータ値を取得します。
removeAsync(name, options, callback)	セッションデータキーと値のペアを削除します。
removeAsync(name, callback)	セッションデータキーと値のペアを削除します。
setAsync(name, value, options, callback)	セッションデータのキーと値のペアを設定します。
setAsync(name, value, callback)	セッションデータのキーと値のペアを設定します。

メソッドの詳細

clearAsync(options, callback)

すべてのセッションデータキーと値のペアをクリアします。

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

パラメーター

options: Office.AsyncContextOptions

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

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

省略可能。メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.11 ]

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

適用される Outlook モード: Compose

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.clearAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("sessionData.clearAsync succeeded");
  } else {
    console.log("Failed to clear sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

clearAsync(callback)

すべてのセッションデータキーと値のペアをクリアします。

clearAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

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

戻り値

void

注釈

[ API セット: メールボックス 1.11 ]

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

適用される Outlook モード: Compose

getAllAsync(callback)

すべてのセッションデータキーと値のペアを取得します。

getAllAsync(callback: (asyncResult: Office.AsyncResult<object>) => void): void;

パラメーター

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

メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.11 ]

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

適用される Outlook モード: Compose

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

getAsync(name, callback)

指定したキーのセッションデータ値を取得します。

getAsync(name: string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

name: string

セッションデータキー。

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

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.11 ]

最小アクセス許可レベル: 読み取り項目

適用される Outlook モード: Compose

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAsync(
  "Date",
  function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData value is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

removeAsync(name, options, callback)

セッションデータキーと値のペアを削除します。

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

パラメーター

name: string

セッションデータキー。

options: Office.AsyncContextOptions

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

戻り値

void

注釈

[ API セット: メールボックス 1.11 ]

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

適用される Outlook モード: Compose

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.removeAsync(
  "Date",
  function callback(asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("sessionData.removeAsync succeeded");
    } else {
      console.log("Failed to remove sessionData. Error: " + JSON.stringify(asyncResult.error));
    }
  }
);

removeAsync(name, callback)

セッションデータキーと値のペアを削除します。

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

パラメーター

name: string

セッションデータキー。

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

戻り値

void

注釈

[ API セット: メールボックス 1.11 ]

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

適用される Outlook モード: Compose

setAsync(name, value, options, callback)

セッションデータのキーと値のペアを設定します。

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

パラメーター

name: string

セッションデータキー。

value: string

セッションデータ値を文字列として指定します。

options: Office.AsyncContextOptions

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

省略可能。メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.11 ]

最小アクセス許可レベル: 読み取り項目

適用される Outlook モード: Compose

重要: メールアイテムごとに、SessionData オブジェクト全体はアドインあたり 50,000 文字に制限されます。

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.setAsync(
  "Date",
  "7/24/2020",
  function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("sessionData.setAsync succeeded");
  } else {
    console.log("Failed to set sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

setAsync(name, value, callback)

セッションデータのキーと値のペアを設定します。

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

パラメーター

name: string

セッションデータキー。

value: string

セッションデータ値を文字列として指定します。

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

省略可能。メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.11 ]

最小アクセス許可レベル: 読み取り項目

適用される Outlook モード: Compose

重要: メールアイテムごとに、SessionData オブジェクト全体はアドインあたり 50,000 文字に制限されます。

次の方法で共有

Office.SessionData interface

注釈

メソッド

メソッドの詳細

clearAsync(options, callback)

パラメーター

戻り値

注釈

例

clearAsync(callback)

パラメーター

戻り値

注釈

getAllAsync(callback)

パラメーター

戻り値

注釈

例

getAsync(name, callback)

パラメーター

戻り値

注釈

例

removeAsync(name, options, callback)

パラメーター

戻り値

注釈

例

removeAsync(name, callback)

パラメーター

戻り値

注釈

setAsync(name, value, options, callback)

パラメーター

戻り値

注釈

例

setAsync(name, value, callback)

パラメーター

戻り値

注釈

その他のリソース