OfficeRuntime.Storage interface

Пакет:

office-runtime

Асинхронное, глобальное и постоянное хранилище ключей и значений.

Комментарии

[ Набор API: SharedRuntime 1.1, Mailbox 1.10 ]

Этот интерфейс доступен в наборе требований SharedRuntime 1.1 для надстроек Excel, PowerPoint и Word. Он также доступен, начиная с набора обязательных почтовых ящиков 1.10 для Outlook.

Важно! В Outlook поддержка доступна только с функцией активации на основе событий , реализованной в Outlook в Windows. Этот интерфейс не поддерживается в Outlook на Mac или в Интернете.

Ограничение хранилища составляет 10 МБ на домен, который может совместно использоваться несколькими надстройками.

Методы

getItem(key)	Извлекает элемент из хранилища на основе его ключа. Возвращает обещание. Если обещание не разрешается, возвращает значение NULL.
getItems(keys)	Извлекает несколько элементов из хранилища на основе их ключа. Возвращает обещание. Если обещание не разрешается, возвращает значение NULL.
getKeys()	Извлекает массив всех ключей из хранилища. Возвращает обещание.
removeItem(key)	Удаляет элемент из хранилища на основе его ключа. Возвращает обещание.
removeItems(keys)	Удаляет несколько элементов из хранилища. Возвращает обещание.
setItem(key, value)	Задает пару "ключ-значение" в хранилище или обновляет существующую пару "ключ-значение". Возвращает обещание.
setItems(keyValues)	Задает несколько элементов в хранилище или обновляет несколько элементов в хранилище. Возвращает обещание.

Сведения о методе

getItem(key)

Извлекает элемент из хранилища на основе его ключа. Возвращает обещание. Если обещание не разрешается, возвращает значение NULL.

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

Параметры

key

string

Ключ извлекаемого элемента. Должен быть строкой.

Возвращаемое значение

Promise<string | null>

Комментарии

[ Набор API: SharedRuntime 1.1, Mailbox 1.10 ]

Этот метод доступен в наборе требований SharedRuntime 1.1 для надстроек Excel, PowerPoint и Word. Он также доступен, начиная с набора обязательных почтовых ящиков 1.10 для Outlook.

Важно! В Outlook поддержка доступна только с функцией активации на основе событий , реализованной в Outlook в Windows. Этот метод не поддерживается в Outlook на Mac или в Интернете.

getItems(keys)

Извлекает несколько элементов из хранилища на основе их ключа. Возвращает обещание. Если обещание не разрешается, возвращает значение NULL.

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

Параметры

keys

string[]

Ключи удаляемых элементов. Должен быть массивом строк.

Возвращаемое значение

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

Комментарии

[ Набор API: SharedRuntime 1.1, Mailbox 1.10 ]

Этот метод доступен в наборе требований SharedRuntime 1.1 для надстроек Excel, PowerPoint и Word. Он также доступен, начиная с набора обязательных почтовых ящиков 1.10 для Outlook.

Важно! В Outlook поддержка доступна только с функцией активации на основе событий , реализованной в Outlook в Windows. Этот метод не поддерживается в Outlook на Mac или в Интернете.

getKeys()

Извлекает массив всех ключей из хранилища. Возвращает обещание.

getKeys(): Promise<string[]>;

Возвращаемое значение

Promise<string[]>

Комментарии

[ Набор API: SharedRuntime 1.1, Mailbox 1.10 ]

Этот метод доступен в наборе требований SharedRuntime 1.1 для надстроек Excel, PowerPoint и Word. Он также доступен, начиная с набора обязательных почтовых ящиков 1.10 для Outlook.

Важно! В Outlook поддержка доступна только с функцией активации на основе событий , реализованной в Outlook в Windows. Этот метод не поддерживается в Outlook на Mac или в Интернете.

removeItem(key)

Удаляет элемент из хранилища на основе его ключа. Возвращает обещание.

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

Параметры

key

string

Ключ удаляемого элемента. Должен быть строкой.

Возвращаемое значение

Promise<void>

Комментарии

[ Набор API: SharedRuntime 1.1, Mailbox 1.10 ]

Этот метод доступен в наборе требований SharedRuntime 1.1 для надстроек Excel, PowerPoint и Word. Он также доступен, начиная с набора обязательных почтовых ящиков 1.10 для Outlook.

Важно! В Outlook поддержка доступна только с функцией активации на основе событий , реализованной в Outlook в Windows. Этот метод не поддерживается в Outlook на Mac или в Интернете.

removeItems(keys)

Удаляет несколько элементов из хранилища. Возвращает обещание.

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

Параметры

keys

string[]

Ключи удаляемых элементов. Должен быть массивом строк.

Возвращаемое значение

Promise<void>

Комментарии

[ Набор API: SharedRuntime 1.1, Mailbox 1.10 ]

Этот метод доступен в наборе требований SharedRuntime 1.1 для надстроек Excel, PowerPoint и Word. Он также доступен, начиная с набора обязательных почтовых ящиков 1.10 для Outlook.

Важно! В Outlook поддержка доступна только с функцией активации на основе событий , реализованной в Outlook в Windows. Этот метод не поддерживается в Outlook на Mac или в Интернете.

setItem(key, value)

Задает пару "ключ-значение" в хранилище или обновляет существующую пару "ключ-значение". Возвращает обещание.

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

Параметры

key

string

Ключ элемента, который нужно задать. Должен быть строкой.

value

string

Должен быть строкой.

Возвращаемое значение

Promise<void>

Комментарии

[ Набор API: SharedRuntime 1.1, Mailbox 1.10 ]

Этот метод доступен в наборе требований SharedRuntime 1.1 для надстроек Excel, PowerPoint и Word. Он также доступен, начиная с набора обязательных почтовых ящиков 1.10 для Outlook.

Важно! В Outlook поддержка доступна только с функцией активации на основе событий , реализованной в Outlook в Windows. Этот метод не поддерживается в Outlook на Mac или в Интернете.

setItems(keyValues)

Задает несколько элементов в хранилище или обновляет несколько элементов в хранилище. Возвращает обещание.

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

Параметры

keyValues

{ [key: string]: string }

Пары "ключ-значение", которые необходимо задать. Должны быть строками.

Возвращаемое значение

Promise<void>

Комментарии

[ Набор API: SharedRuntime 1.1, Mailbox 1.10 ]

Этот метод доступен в наборе требований SharedRuntime 1.1 для надстроек Excel, PowerPoint и Word. Он также доступен, начиная с набора обязательных почтовых ящиков 1.10 для Outlook.

Важно! В Outlook поддержка доступна только с функцией активации на основе событий , реализованной в Outlook в Windows. Этот метод не поддерживается в Outlook на Mac или в Интернете.