OfficeRuntime.Storage interface

Ruft ein Element basierend auf seinem Schlüssel aus dem Speicher ab. Gibt eine Zusage zurück. Falls die Zusage nicht aufgelöst wird, wird null zurückgegeben.

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

Parameter

Gibt zurück

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. Sie ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

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

Beispiele

// Retrieve a value from the shared runtime storage by its key.
async function getItem() {
    const key = document.getElementById('readKey').value.trim();

    const value = await OfficeRuntime.storage.getItem(key);

    if (value === null) {
        console.log(`Item not found - Key "${key}" not found in storage.`);
    } else {
        console.log(`Item retrieved successfully - Key: "${key}"\nValue: "${value}"`);
    }
}

Ruft mehrere Elemente basierend auf ihrem Schlüssel aus dem Speicher ab. Gibt eine Zusage zurück. Falls die Zusage nicht aufgelöst wird, wird null zurückgegeben.

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

Parameter

Gibt zurück

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. Sie ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

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

Beispiele

// Retrieve a set of default values from the shared runtime storage.
async function getDefaultSettings() {
  const keysToRetrieve = [
      'username',
      'email',
      'theme',
      'lastLogin',
      'preferences'
  ];

  const items = await OfficeRuntime.storage.getItems(keysToRetrieve);
  for (const [key, value] of Object.entries(items)) {
      console.log(`"${key}": "${value}"`);
  }
}

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

getKeys(): Promise<string[]>;

Gibt zurück

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. Sie ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

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

Beispiele

// Retrieve all keys currently stored in the shared runtime storage.
async function getAllKeys() {
  const keys = await OfficeRuntime.storage.getKeys();

  if (keys.length === 0) {
    console.log('No items in storage.');
    showStatus('Storage is empty', 'info');
  } else {
    console.log(`Found ${keys.length} key(s):\n\n${keys.toString()}`);
  }
}

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

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

Parameter

Gibt zurück

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. Sie ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

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

Beispiele

// Delete an item from the shared runtime storage by its key.
async function removeItem() {
    const key = document.getElementById('deleteKey').value.trim();
        
    // Check if key exists first.
    const value = await OfficeRuntime.storage.getItem(key);

    if (value === null) {
        console.log(`Key "${key}" not found`);
    } else {
      await OfficeRuntime.storage.removeItem(key);
      console.log(`Item "${key}" removed successfully`);
    }
}

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

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

Parameter

Gibt zurück

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. Sie ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

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

Beispiele

// Delete all the items from the shared runtime storage.
async function clearAllStorage() {
  const keys = await OfficeRuntime.storage.getKeys();
  await OfficeRuntime.storage.removeItems(keys);
  console.log(`All ${keys.length} items cleared from storage`);
}

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

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

Parameter

Gibt zurück

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. Sie ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

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

Beispiele

// Save a key-value pair in the shared runtime storage.
async function storeValue() {
  const key = document.getElementById('createKey').value.trim();
  const value = document.getElementById('createValue').value.trim();

  await OfficeRuntime.storage.setItem(key, value);
}

Legt mehrere Elemente im Speicher ab oder aktualisiert mehrere Elemente im Speicher. Gibt eine Zusage zurück.

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

Parameter

Gibt zurück

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. Sie ist auch ab Postfachanforderungssatz 1.10 für Outlook verfügbar.

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

Beispiele

// Save multiple key-value pairs in the shared runtime storage.
async function setDefaultSettings() {
  const demoData = {
      'username': 'JohnDoe',
      'email': 'john.doe@example.com',
      'theme': 'dark',
      'lastLogin': new Date().toISOString(),
      'preferences': JSON.stringify({ notifications: true, language: 'en' })
  };

  await OfficeRuntime.storage.setItems(demoData);
}