Office.SessionData interface

参考

包:: outlook

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

重要提示：每个外接程序的整个 SessionData 对象限制为 50，000 个字符。

注解

[ API set： Mailbox 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

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

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

可选。方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。

void

注解

[ API set： Mailbox 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

可选。方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。

void

注解

[ API set： Mailbox 1.11 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

getAllAsync(callback)

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

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

参数

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

方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。

void

注解

[ API set： Mailbox 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

方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。

void

注解

[ API set： Mailbox 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

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

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

可选。方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。

void

注解

[ API set： Mailbox 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

可选。方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。

void

注解

[ API set： Mailbox 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

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

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

可选。方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。

void

注解

[ API set： Mailbox 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

可选。方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。

void

注解

[ API set： Mailbox 1.11 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

通过

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)

参数

返回

注解

其他资源