OfficeRuntime.Storage interface

Recupera un elemento del almacenamiento en función de su clave. Devuelve una promesa. En caso de que la promesa no se resuelva, devuelve un valor nulo.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: SharedRuntime 1.1, Buzón 1.10

Este método está disponible en el conjunto de requisitos de SharedRuntime 1.1 para los complementos de Excel, PowerPoint y Word. También está disponible a partir del conjunto de requisitos de buzón 1.10 para Outlook.

Importante: En Outlook, la compatibilidad solo está disponible con la característica de activación basada en eventos implementada en Outlook en Windows. Este método no es compatible con Outlook en Mac ni en la Web.

Ejemplos

// 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}"`);
    }
}

Recupera varios elementos del almacenamiento en función de su clave. Devuelve una promesa. En caso de que la promesa no se resuelva, devuelve un valor nulo.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: SharedRuntime 1.1, Buzón 1.10

Este método está disponible en el conjunto de requisitos de SharedRuntime 1.1 para los complementos de Excel, PowerPoint y Word. También está disponible a partir del conjunto de requisitos de buzón 1.10 para Outlook.

Importante: En Outlook, la compatibilidad solo está disponible con la característica de activación basada en eventos implementada en Outlook en Windows. Este método no es compatible con Outlook en Mac ni en la Web.

Ejemplos

// 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}"`);
  }
}

Recupera una matriz de todas las claves del almacenamiento. Devuelve una promesa.

getKeys(): Promise<string[]>;

Devoluciones

Comentarios

Conjunto de API: SharedRuntime 1.1, Buzón 1.10

Este método está disponible en el conjunto de requisitos de SharedRuntime 1.1 para los complementos de Excel, PowerPoint y Word. También está disponible a partir del conjunto de requisitos de buzón 1.10 para Outlook.

Importante: En Outlook, la compatibilidad solo está disponible con la característica de activación basada en eventos implementada en Outlook en Windows. Este método no es compatible con Outlook en Mac ni en la Web.

Ejemplos

// 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()}`);
  }
}

Quita un elemento del almacenamiento en función de su clave. Devuelve una promesa.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: SharedRuntime 1.1, Buzón 1.10

Este método está disponible en el conjunto de requisitos de SharedRuntime 1.1 para los complementos de Excel, PowerPoint y Word. También está disponible a partir del conjunto de requisitos de buzón 1.10 para Outlook.

Importante: En Outlook, la compatibilidad solo está disponible con la característica de activación basada en eventos implementada en Outlook en Windows. Este método no es compatible con Outlook en Mac ni en la Web.

Ejemplos

// 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`);
    }
}

Retira varios elementos del almacenamiento. Devuelve una promesa.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: SharedRuntime 1.1, Buzón 1.10

Este método está disponible en el conjunto de requisitos de SharedRuntime 1.1 para los complementos de Excel, PowerPoint y Word. También está disponible a partir del conjunto de requisitos de buzón 1.10 para Outlook.

Importante: En Outlook, la compatibilidad solo está disponible con la característica de activación basada en eventos implementada en Outlook en Windows. Este método no es compatible con Outlook en Mac ni en la Web.

Ejemplos

// 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`);
}

Establece un par clave-valor en el almacenamiento o actualiza un par clave-valor existente. Devuelve una promesa.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: SharedRuntime 1.1, Buzón 1.10

Este método está disponible en el conjunto de requisitos de SharedRuntime 1.1 para los complementos de Excel, PowerPoint y Word. También está disponible a partir del conjunto de requisitos de buzón 1.10 para Outlook.

Importante: En Outlook, la compatibilidad solo está disponible con la característica de activación basada en eventos implementada en Outlook en Windows. Este método no es compatible con Outlook en Mac ni en la Web.

Ejemplos

// 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);
}

Coloca varios elementos en el almacenamiento o actualiza varios elementos dentro del almacenamiento. Devuelve una promesa.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: SharedRuntime 1.1, Buzón 1.10

Este método está disponible en el conjunto de requisitos de SharedRuntime 1.1 para los complementos de Excel, PowerPoint y Word. También está disponible a partir del conjunto de requisitos de buzón 1.10 para Outlook.

Importante: En Outlook, la compatibilidad solo está disponible con la característica de activación basada en eventos implementada en Outlook en Windows. Este método no es compatible con Outlook en Mac ni en la Web.

Ejemplos

// 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);
}