OfficeRuntime.Storage interface

包:

office-runtime

异步、全局和持久性键值存储。

注解

[ API set： SharedRuntime 1.1，Mailbox 1.10 ]

此接口在 Excel、PowerPoint 和 Word 加载项的 SharedRuntime 1.1 要求集中提供。它还可从 Outlook 的邮箱要求集 1.10 开始提供。

重要提示：在 Outlook 中，仅支持 Windows 版 Outlook 中实现 的基于事件的激活 功能。 Outlook on Mac 或 Web 上不支持此接口。

每个域的存储限制为 10 MB，可由多个加载项共享。

方法

getItem(key)	根据项的键从存储中检索项。 返回 Promise。 如果 Promise 无法解析，则返回 null。
getItems(keys)	根据项的密钥从存储中检索多个项。 返回 Promise。 如果 Promise 无法解析，则返回 null。
getKeys()	从存储中检索所有密钥的数组。 返回 Promise。
removeItem(key)	根据项的键从存储中删除项。 返回 Promise。
removeItems(keys)	从存储中删除多个项。 返回 Promise。
setItem(key, value)	将键值对设置为存储或更新现有的键值对。 返回 Promise。
setItems(keyValues)	将多个项设置为存储或更新存储中的多个项。 返回 Promise。

方法详细信息

getItem(key)

根据项的键从存储中检索项。 返回 Promise。 如果 Promise 无法解析，则返回 null。

getItem(key: string): Promise<string | null>;

参数

key

string

要检索的项的键。 必须是字符串。

返回

Promise<string | null>

注解

[ API set： SharedRuntime 1.1，Mailbox 1.10 ]

此方法在 Excel、PowerPoint 和 Word 加载项的 SharedRuntime 1.1 要求集中可用。它还可从 Outlook 的邮箱要求集 1.10 开始提供。

重要提示：在 Outlook 中，仅支持 Windows 版 Outlook 中实现 的基于事件的激活 功能。 Outlook on Mac 或 Web 上不支持此方法。

getItems(keys)

根据项的密钥从存储中检索多个项。 返回 Promise。 如果 Promise 无法解析，则返回 null。

getItems(keys: string[]): Promise<{ [key: string]: string | null }>;

参数

keys

string[]

要删除的项的键。 必须是字符串数组。

返回

Promise<{ [key: string]: string | null }>

注解

[ API set： SharedRuntime 1.1，Mailbox 1.10 ]

此方法在 Excel、PowerPoint 和 Word 加载项的 SharedRuntime 1.1 要求集中可用。它还可从 Outlook 的邮箱要求集 1.10 开始提供。

重要提示：在 Outlook 中，仅支持 Windows 版 Outlook 中实现 的基于事件的激活 功能。 Outlook on Mac 或 Web 上不支持此方法。

getKeys()

从存储中检索所有密钥的数组。 返回 Promise。

getKeys(): Promise<string[]>;

返回

Promise<string[]>

注解

[ API set： SharedRuntime 1.1，Mailbox 1.10 ]

此方法在 Excel、PowerPoint 和 Word 加载项的 SharedRuntime 1.1 要求集中可用。它还可从 Outlook 的邮箱要求集 1.10 开始提供。

重要提示：在 Outlook 中，仅支持 Windows 版 Outlook 中实现 的基于事件的激活 功能。 Outlook on Mac 或 Web 上不支持此方法。

removeItem(key)

根据项的键从存储中删除项。 返回 Promise。

removeItem(key: string): Promise<void>;

参数

key

string

要删除的项的键。 必须是字符串。

返回

Promise<void>

注解

[ API set： SharedRuntime 1.1，Mailbox 1.10 ]

此方法在 Excel、PowerPoint 和 Word 加载项的 SharedRuntime 1.1 要求集中可用。它还可从 Outlook 的邮箱要求集 1.10 开始提供。

重要提示：在 Outlook 中，仅支持 Windows 版 Outlook 中实现 的基于事件的激活 功能。 Outlook on Mac 或 Web 上不支持此方法。

removeItems(keys)

从存储中删除多个项。 返回 Promise。

removeItems(keys: string[]): Promise<void>;

参数

keys

string[]

要删除的项的键。 必须是字符串数组。

返回

Promise<void>

注解

[ API set： SharedRuntime 1.1，Mailbox 1.10 ]

此方法在 Excel、PowerPoint 和 Word 加载项的 SharedRuntime 1.1 要求集中可用。它还可从 Outlook 的邮箱要求集 1.10 开始提供。

重要提示：在 Outlook 中，仅支持 Windows 版 Outlook 中实现 的基于事件的激活 功能。 Outlook on Mac 或 Web 上不支持此方法。

setItem(key, value)

将键值对设置为存储或更新现有的键值对。 返回 Promise。

setItem(key: string, value: string): Promise<void>;

参数

key

string

要设置的项的键。 必须是字符串。

value

string

必须是字符串。

返回

Promise<void>

注解

[ API set： SharedRuntime 1.1，Mailbox 1.10 ]

此方法在 Excel、PowerPoint 和 Word 加载项的 SharedRuntime 1.1 要求集中可用。它还可从 Outlook 的邮箱要求集 1.10 开始提供。

重要提示：在 Outlook 中，仅支持 Windows 版 Outlook 中实现 的基于事件的激活 功能。 Outlook on Mac 或 Web 上不支持此方法。

setItems(keyValues)

将多个项设置为存储或更新存储中的多个项。 返回 Promise。

setItems(keyValues: { [key: string]: string }): Promise<void>;

参数

keyValues

{ [key: string]: string }

要设置的键值对。 必须是字符串。

返回

Promise<void>

注解

[ API set： SharedRuntime 1.1，Mailbox 1.10 ]

此方法在 Excel、PowerPoint 和 Word 加载项的 SharedRuntime 1.1 要求集中可用。它还可从 Outlook 的邮箱要求集 1.10 开始提供。

重要提示：在 Outlook 中，仅支持 Windows 版 Outlook 中实现 的基于事件的激活 功能。 Outlook on Mac 或 Web 上不支持此方法。