Office.SessionData interface

提供管理项的会话数据的方法。

会话数据特定于单个邮件项目。即使相同的加载项用于设置或检索数据，它也不在多个项之间共享。

注解

重要提示：在支持邮箱 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

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们希望访问的任何对象。

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

可选。当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。

返回

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

可选。当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。

返回

void

注解

API 集：邮箱 1.11

最低权限级别： 读取/写入项目

适用的 Outlook 模式：Compose

getAllAsync(callback)

获取所有会话数据键值对。

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

参数

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

当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。

返回

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为 .

返回

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

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们希望访问的任何对象。

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

可选。当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。

返回

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

可选。当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。

返回

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

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们希望访问的任何对象。

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

可选。当该方法完成时， callback 将使用类型 Office.AsyncResult为 .

返回

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为 .

返回

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)

参数

返回

注解

反馈