OfficeRuntime.Storage interface

パッケージ:

office-runtime

非同期、グローバル、および永続的なキー値ストレージ。

注釈

[ API セット: SharedRuntime 1.1, Mailbox 1.10 ]

このインターフェイスは、Excel、PowerPoint、Word アドインの SharedRuntime 1.1 要件セットで使用できます。Outlook のメールボックス要件セット 1.10 以降でも使用できます。

重要: Outlook では、サポートは、Outlook on Windows で実装されている イベント ベースのアクティブ化 機能でのみ使用できます。 このインターフェイスは、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 セット: SharedRuntime 1.1, Mailbox 1.10 ]

このメソッドは、Excel、PowerPoint、Word アドインの SharedRuntime 1.1 要件セットで使用できます。Outlook のメールボックス要件セット 1.10 以降でも使用できます。

重要: Outlook では、サポートは、Outlook on Windows で実装されている イベント ベースのアクティブ化 機能でのみ使用できます。 この方法は、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 セット: SharedRuntime 1.1, Mailbox 1.10 ]

このメソッドは、Excel、PowerPoint、Word アドインの SharedRuntime 1.1 要件セットで使用できます。Outlook のメールボックス要件セット 1.10 以降でも使用できます。

重要: Outlook では、サポートは、Outlook on Windows で実装されている イベント ベースのアクティブ化 機能でのみ使用できます。 この方法は、Outlook on Mac または Web ではサポートされていません。

getKeys()

ストレージからすべてのキーの配列を取得します。 Promise を返します。

getKeys(): Promise<string[]>;

戻り値

Promise<string[]>

注釈

[ API セット: SharedRuntime 1.1, Mailbox 1.10 ]

このメソッドは、Excel、PowerPoint、Word アドインの SharedRuntime 1.1 要件セットで使用できます。Outlook のメールボックス要件セット 1.10 以降でも使用できます。

重要: Outlook では、サポートは、Outlook on Windows で実装されている イベント ベースのアクティブ化 機能でのみ使用できます。 この方法は、Outlook on Mac または Web ではサポートされていません。

removeItem(key)

キーに基づいてストレージから項目を削除します。 Promise を返します。

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

パラメーター

key

string

削除する項目のキー。 文字列にする必要があります。

戻り値

Promise<void>

注釈

[ API セット: SharedRuntime 1.1, Mailbox 1.10 ]

このメソッドは、Excel、PowerPoint、Word アドインの SharedRuntime 1.1 要件セットで使用できます。Outlook のメールボックス要件セット 1.10 以降でも使用できます。

重要: Outlook では、サポートは、Outlook on Windows で実装されている イベント ベースのアクティブ化 機能でのみ使用できます。 この方法は、Outlook on Mac または Web ではサポートされていません。

removeItems(keys)

ストレージから複数の項目を削除します。 Promise を返します。

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

パラメーター

keys

string[]

削除する項目のキー。 文字列の配列である必要があります。

戻り値

Promise<void>

注釈

[ API セット: SharedRuntime 1.1, Mailbox 1.10 ]

このメソッドは、Excel、PowerPoint、Word アドインの SharedRuntime 1.1 要件セットで使用できます。Outlook のメールボックス要件セット 1.10 以降でも使用できます。

重要: Outlook では、サポートは、Outlook on Windows で実装されている イベント ベースのアクティブ化 機能でのみ使用できます。 この方法は、Outlook on Mac または Web ではサポートされていません。

setItem(key, value)

キーと値のペアをストレージに設定するか、既存のキーと値のペアを更新します。 Promise を返します。

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

パラメーター

key

string

設定する項目のキー。 文字列にする必要があります。

value

string

文字列にする必要があります。

戻り値

Promise<void>

注釈

[ API セット: SharedRuntime 1.1, Mailbox 1.10 ]

このメソッドは、Excel、PowerPoint、Word アドインの SharedRuntime 1.1 要件セットで使用できます。Outlook のメールボックス要件セット 1.10 以降でも使用できます。

重要: Outlook では、サポートは、Outlook on Windows で実装されている イベント ベースのアクティブ化 機能でのみ使用できます。 この方法は、Outlook on Mac または Web ではサポートされていません。

setItems(keyValues)

複数の項目をストレージに設定するか、ストレージ内の複数の項目を更新します。 Promise を返します。

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

パラメーター

keyValues

{ [key: string]: string }

設定するキーと値のペア。 文字列である必要があります。

戻り値

Promise<void>

注釈

[ API セット: SharedRuntime 1.1, Mailbox 1.10 ]

このメソッドは、Excel、PowerPoint、Word アドインの SharedRuntime 1.1 要件セットで使用できます。Outlook のメールボックス要件セット 1.10 以降でも使用できます。

重要: Outlook では、サポートは、Outlook on Windows で実装されている イベント ベースのアクティブ化 機能でのみ使用できます。 この方法は、Outlook on Mac または Web ではサポートされていません。