Office.SessionData interface

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

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

注釈

重要: メールボックス 1.15 以前をサポートする Outlook クライアントでは、各メールアイテムの SessionData オブジェクト全体はアドインあたり 50,000 文字に制限されます。メールボックス 1.16 以降をサポートするクライアントでは、アドインあたりの文字数制限は 2,621,440 文字です。

使用元

メソッド

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

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

返品

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

次のプロパティの 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.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

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

返品

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

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

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

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

返品

void

注釈

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

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

適用可能な Outlook モード: Compose

重要: メールボックス 1.15 以前をサポートする Outlook クライアントでは、各メールアイテムの SessionData オブジェクト全体はアドインあたり 50,000 文字に制限されます。メールボックス 1.16 以降をサポートするクライアントでは、アドインあたりの文字数制限は 2,621,440 文字です。

例

// 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

重要: メールボックス 1.15 以前をサポートする Outlook クライアントでは、各メールアイテムの SessionData オブジェクト全体はアドインあたり 50,000 文字に制限されます。メールボックス 1.16 以降をサポートするクライアントでは、アドインあたりの文字数制限は 2,621,440 文字です。

注釈

使用元

メソッド

メソッドの詳細

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)

パラメーター

返品

注釈

フィードバック