OfficeRuntime.Storage interface

  • Referenz
Paket:
office-runtime

Asynchroner, globaler und persistenter Schlüssel-Wert-Speicher.

Hinweise

[ API-Satz: SharedRuntime 1.1, Mailbox 1.10 ]

Diese Schnittstelle ist im SharedRuntime 1.1-Anforderungssatz für Excel-, PowerPoint- und Word-Add-Ins verfügbar. Es ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

Wichtig: In Outlook ist Support nur mit der ereignisbasierten Aktivierungsfunktion verfügbar, die in Outlook unter Windows implementiert ist. Diese Schnittstelle wird in Outlook für Mac oder im Web nicht unterstützt.

Das Speicherlimit beträgt 10 MB pro Domäne, die von mehreren Add-Ins gemeinsam genutzt werden können.

Methoden

getItem(key)

Ruft ein Element basierend auf seinem Schlüssel aus dem Speicher ab. Gibt eine Zusage zurück. Für den Fall, dass die Zusage nicht aufgelöst wird, gibt NULL zurück.
getItems(keys)

Ruft mehrere Elemente basierend auf ihrem Schlüssel aus dem Speicher ab. Gibt eine Zusage zurück. Für den Fall, dass die Zusage nicht aufgelöst wird, gibt NULL zurück.
getKeys()

Ruft ein Array aller Schlüssel aus dem Speicher ab. Gibt eine Zusage zurück.
removeItem(key)

Entfernt ein Element basierend auf seinem Schlüssel aus dem Speicher. Gibt eine Zusage zurück.
removeItems(keys)

Entfernt mehrere Elemente aus dem Speicher. Gibt eine Zusage zurück.
setItem(key, value)

Legt ein Schlüssel-Wert-Paar in den Speicher fest oder aktualisiert ein vorhandenes Schlüssel-Wert-Paar. Gibt eine Zusage zurück.
setItems(keyValues)

Legt mehrere Elemente in den Speicher fest oder aktualisiert mehrere Elemente im Speicher. Gibt eine Zusage zurück.

Details zur Methode

getItem(key)

Ruft ein Element basierend auf seinem Schlüssel aus dem Speicher ab. Gibt eine Zusage zurück. Für den Fall, dass die Zusage nicht aufgelöst wird, gibt NULL zurück.

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

Parameter

key

string

Schlüssel des abzurufenden Elements. Muss eine Zeichenfolge sein.

Gibt zurück

Promise<string | null>

Hinweise

[ API-Satz: SharedRuntime 1.1, Mailbox 1.10 ]

Diese Methode ist im SharedRuntime 1.1-Anforderungssatz für Excel-, PowerPoint- und Word-Add-Ins verfügbar. Es ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

Wichtig: In Outlook ist Support nur mit der ereignisbasierten Aktivierungsfunktion verfügbar, die in Outlook unter Windows implementiert ist. Diese Methode wird in Outlook auf Mac oder im Web nicht unterstützt.

getItems(keys)

Ruft mehrere Elemente basierend auf ihrem Schlüssel aus dem Speicher ab. Gibt eine Zusage zurück. Für den Fall, dass die Zusage nicht aufgelöst wird, gibt NULL zurück.

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

Parameter

keys

string[]

Schlüssel der zu entfernenden Elemente. Muss ein Array von Zeichenfolgen sein.

Gibt zurück

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

Hinweise

[ API-Satz: SharedRuntime 1.1, Mailbox 1.10 ]

Diese Methode ist im SharedRuntime 1.1-Anforderungssatz für Excel-, PowerPoint- und Word-Add-Ins verfügbar. Es ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

Wichtig: In Outlook ist Support nur mit der ereignisbasierten Aktivierungsfunktion verfügbar, die in Outlook unter Windows implementiert ist. Diese Methode wird in Outlook auf Mac oder im Web nicht unterstützt.

getKeys()

Ruft ein Array aller Schlüssel aus dem Speicher ab. Gibt eine Zusage zurück.

getKeys(): Promise<string[]>;

Gibt zurück

Promise<string[]>

Hinweise

[ API-Satz: SharedRuntime 1.1, Mailbox 1.10 ]

Diese Methode ist im SharedRuntime 1.1-Anforderungssatz für Excel-, PowerPoint- und Word-Add-Ins verfügbar. Es ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

Wichtig: In Outlook ist Support nur mit der ereignisbasierten Aktivierungsfunktion verfügbar, die in Outlook unter Windows implementiert ist. Diese Methode wird in Outlook auf Mac oder im Web nicht unterstützt.

removeItem(key)

Entfernt ein Element basierend auf seinem Schlüssel aus dem Speicher. Gibt eine Zusage zurück.

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

Parameter

key

string

Schlüssel des zu entfernenden Elements. Muss eine Zeichenfolge sein.

Gibt zurück

Promise<void>

Hinweise

[ API-Satz: SharedRuntime 1.1, Mailbox 1.10 ]

Diese Methode ist im SharedRuntime 1.1-Anforderungssatz für Excel-, PowerPoint- und Word-Add-Ins verfügbar. Es ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

Wichtig: In Outlook ist Support nur mit der ereignisbasierten Aktivierungsfunktion verfügbar, die in Outlook unter Windows implementiert ist. Diese Methode wird in Outlook auf Mac oder im Web nicht unterstützt.

removeItems(keys)

Entfernt mehrere Elemente aus dem Speicher. Gibt eine Zusage zurück.

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

Parameter

keys

string[]

Schlüssel der zu entfernenden Elemente. Muss ein Array von Zeichenfolgen sein.

Gibt zurück

Promise<void>

Hinweise

[ API-Satz: SharedRuntime 1.1, Mailbox 1.10 ]

Diese Methode ist im SharedRuntime 1.1-Anforderungssatz für Excel-, PowerPoint- und Word-Add-Ins verfügbar. Es ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

Wichtig: In Outlook ist Support nur mit der ereignisbasierten Aktivierungsfunktion verfügbar, die in Outlook unter Windows implementiert ist. Diese Methode wird in Outlook auf Mac oder im Web nicht unterstützt.

setItem(key, value)

Legt ein Schlüssel-Wert-Paar in den Speicher fest oder aktualisiert ein vorhandenes Schlüssel-Wert-Paar. Gibt eine Zusage zurück.

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

Parameter

key

string

Der Schlüssel des festzulegenden Elements. Muss eine Zeichenfolge sein.

value

string

Muss eine Zeichenfolge sein.

Gibt zurück

Promise<void>

Hinweise

[ API-Satz: SharedRuntime 1.1, Mailbox 1.10 ]

Diese Methode ist im SharedRuntime 1.1-Anforderungssatz für Excel-, PowerPoint- und Word-Add-Ins verfügbar. Es ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

Wichtig: In Outlook ist Support nur mit der ereignisbasierten Aktivierungsfunktion verfügbar, die in Outlook unter Windows implementiert ist. Diese Methode wird in Outlook auf Mac oder im Web nicht unterstützt.

setItems(keyValues)

Legt mehrere Elemente in den Speicher fest oder aktualisiert mehrere Elemente im Speicher. Gibt eine Zusage zurück.

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

Parameter

keyValues

{ [key: string]: string }

Festzulegende Schlüssel-Wert-Paare. Muss Zeichenfolgen sein.

Gibt zurück

Promise<void>

Hinweise

[ API-Satz: SharedRuntime 1.1, Mailbox 1.10 ]

Diese Methode ist im SharedRuntime 1.1-Anforderungssatz für Excel-, PowerPoint- und Word-Add-Ins verfügbar. Es ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

Wichtig: In Outlook ist Support nur mit der ereignisbasierten Aktivierungsfunktion verfügbar, die in Outlook unter Windows implementiert ist. Diese Methode wird in Outlook auf Mac oder im Web nicht unterstützt.