OfficeRuntime.Storage interface

キーに基づいてストレージから項目を取得します。 Promise を返します。 Promise が解決しない場合は、null を返します。

getItem(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 ではサポートされていません。

キーに基づいてストレージから複数の項目を取得します。 Promise を返します。 Promise が解決しない場合は、null を返します。

getItems(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 ではサポートされていません。

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

getKeys(): 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 ではサポートされていません。

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

removeItem(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 ではサポートされていません。

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

removeItems(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 ではサポートされていません。

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

setItem(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 ではサポートされていません。

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

setItems(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 ではサポートされていません。