OfficeRuntime.Storage interface

Recupera um item do armazenamento com base em sua chave. retorna uma promessa. Caso a promessa não seja resolvida, retorna nulo.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: SharedRuntime 1.1, Caixa de Correio 1.10

Esse método está disponível no conjunto de requisitos do SharedRuntime 1.1 para complementos do Excel, PowerPoint e Word. Ele também está disponível a partir do conjunto de requisitos de caixa de correio 1.10 para o Outlook.

Importante: no Outlook, o suporte só está disponível com o recurso de ativação baseada em eventos implementado no Outlook no Windows. Este método não é compatível com o Outlook no Mac ou na Web.

Exemplos

// 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 vários itens do armazenamento com base em sua chave. retorna uma promessa. Caso a promessa não seja resolvida, retorna nulo.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: SharedRuntime 1.1, Caixa de Correio 1.10

Esse método está disponível no conjunto de requisitos do SharedRuntime 1.1 para complementos do Excel, PowerPoint e Word. Ele também está disponível a partir do conjunto de requisitos de caixa de correio 1.10 para o Outlook.

Importante: no Outlook, o suporte só está disponível com o recurso de ativação baseada em eventos implementado no Outlook no Windows. Este método não é compatível com o Outlook no Mac ou na Web.

Exemplos

// 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 uma matriz de todas as chaves do armazenamento. retorna uma promessa.

getKeys(): Promise<string[]>;

Retornos

Comentários

Conjunto de APIs: SharedRuntime 1.1, Caixa de Correio 1.10

Esse método está disponível no conjunto de requisitos do SharedRuntime 1.1 para complementos do Excel, PowerPoint e Word. Ele também está disponível a partir do conjunto de requisitos de caixa de correio 1.10 para o Outlook.

Importante: no Outlook, o suporte só está disponível com o recurso de ativação baseada em eventos implementado no Outlook no Windows. Este método não é compatível com o Outlook no Mac ou na Web.

Exemplos

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

Remove um item do armazenamento com base em sua chave. retorna uma promessa.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: SharedRuntime 1.1, Caixa de Correio 1.10

Esse método está disponível no conjunto de requisitos do SharedRuntime 1.1 para complementos do Excel, PowerPoint e Word. Ele também está disponível a partir do conjunto de requisitos de caixa de correio 1.10 para o Outlook.

Importante: no Outlook, o suporte só está disponível com o recurso de ativação baseada em eventos implementado no Outlook no Windows. Este método não é compatível com o Outlook no Mac ou na Web.

Exemplos

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

Remove vários itens do armazenamento. retorna uma promessa.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: SharedRuntime 1.1, Caixa de Correio 1.10

Esse método está disponível no conjunto de requisitos do SharedRuntime 1.1 para complementos do Excel, PowerPoint e Word. Ele também está disponível a partir do conjunto de requisitos de caixa de correio 1.10 para o Outlook.

Importante: no Outlook, o suporte só está disponível com o recurso de ativação baseada em eventos implementado no Outlook no Windows. Este método não é compatível com o Outlook no Mac ou na Web.

Exemplos

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

Define um par chave-valor no armazenamento ou atualiza um par chave-valor existente. retorna uma promessa.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: SharedRuntime 1.1, Caixa de Correio 1.10

Esse método está disponível no conjunto de requisitos do SharedRuntime 1.1 para complementos do Excel, PowerPoint e Word. Ele também está disponível a partir do conjunto de requisitos de caixa de correio 1.10 para o Outlook.

Importante: no Outlook, o suporte só está disponível com o recurso de ativação baseada em eventos implementado no Outlook no Windows. Este método não é compatível com o Outlook no Mac ou na Web.

Exemplos

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

Define vários itens no armazenamento ou atualiza vários itens no armazenamento. retorna uma promessa.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: SharedRuntime 1.1, Caixa de Correio 1.10

Esse método está disponível no conjunto de requisitos do SharedRuntime 1.1 para complementos do Excel, PowerPoint e Word. Ele também está disponível a partir do conjunto de requisitos de caixa de correio 1.10 para o Outlook.

Importante: no Outlook, o suporte só está disponível com o recurso de ativação baseada em eventos implementado no Outlook no Windows. Este método não é compatível com o Outlook no Mac ou na Web.

Exemplos

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