次の方法で共有


Office.SessionData interface

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

重要: SessionData オブジェクト全体は、アドインあたり 50,000 文字に制限されています。

注釈

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

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成

メソッド

clearAsync(options, callback)

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

clearAsync(callback)

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

getAllAsync(callback)

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

getAsync(name, callback)

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

removeAsync(name, options, callback)

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

removeAsync(name, callback)

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

setAsync(name, value, options, callback)

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

重要: SessionData オブジェクト全体は、アドインあたり 50,000 文字に制限されています。

setAsync(name, value, callback)

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

重要: SessionData オブジェクト全体は、アドインあたり 50,000 文字に制限されています。

メソッドの詳細

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渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。

戻り値

void

注釈

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

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

適用できる Outlook モード: 新規作成

// 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渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。

戻り値

void

注釈

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

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

適用できる Outlook モード: 新規作成

getAllAsync(callback)

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

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

パラメーター

callback

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

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

戻り値

void

注釈

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

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

適用できる Outlook モード: 新規作成

// 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 モード: 新規作成

// 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渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。

戻り値

void

注釈

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

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

適用できる Outlook モード: 新規作成

// 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渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。

戻り値

void

注釈

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

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

適用できる Outlook モード: 新規作成

setAsync(name, value, options, callback)

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

重要: SessionData オブジェクト全体は、アドインあたり 50,000 文字に制限されています。

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 モード: 新規作成

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

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

重要: SessionData オブジェクト全体は、アドインあたり 50,000 文字に制限されています。

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 モード: 新規作成