OfficeRuntime.Storage interface

Récupère un élément du stockage en fonction de sa clé. Renvoie une promesse. Si la promesse n’est pas résolue, retourne la valeur nulle.

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

Paramètres

Retours

Remarques

Jeu d’API : SharedRuntime 1.1, Mailbox 1.10

Cette méthode est disponible dans la configuration requise SharedRuntime 1.1 définie pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises 1.10 pour Outlook.

Important : dans Outlook, la prise en charge n’est disponible qu’avec la fonctionnalité d’activation basée sur les événements implémentée dans Outlook sur Windows. Cette méthode n’est pas prise en charge dans Outlook sur Mac ou sur le web.

Exemples

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

Récupère plusieurs éléments du stockage en fonction de leur clé. Renvoie une promesse. Si la promesse n’est pas résolue, retourne la valeur nulle.

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

Paramètres

Retours

Remarques

Jeu d’API : SharedRuntime 1.1, Mailbox 1.10

Cette méthode est disponible dans la configuration requise SharedRuntime 1.1 définie pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises 1.10 pour Outlook.

Important : dans Outlook, la prise en charge n’est disponible qu’avec la fonctionnalité d’activation basée sur les événements implémentée dans Outlook sur Windows. Cette méthode n’est pas prise en charge dans Outlook sur Mac ou sur le web.

Exemples

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

Récupère un tableau de toutes les clés du stockage. Renvoie une promesse.

getKeys(): Promise<string[]>;

Retours

Remarques

Jeu d’API : SharedRuntime 1.1, Mailbox 1.10

Cette méthode est disponible dans la configuration requise SharedRuntime 1.1 définie pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises 1.10 pour Outlook.

Important : dans Outlook, la prise en charge n’est disponible qu’avec la fonctionnalité d’activation basée sur les événements implémentée dans Outlook sur Windows. Cette méthode n’est pas prise en charge dans Outlook sur Mac ou sur le web.

Exemples

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

Supprime un élément du stockage en fonction de sa clé. Renvoie une promesse.

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

Paramètres

Retours

Remarques

Jeu d’API : SharedRuntime 1.1, Mailbox 1.10

Cette méthode est disponible dans la configuration requise SharedRuntime 1.1 définie pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises 1.10 pour Outlook.

Important : dans Outlook, la prise en charge n’est disponible qu’avec la fonctionnalité d’activation basée sur les événements implémentée dans Outlook sur Windows. Cette méthode n’est pas prise en charge dans Outlook sur Mac ou sur le web.

Exemples

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

Retire plusieurs éléments du stockage. Renvoie une promesse.

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

Paramètres

Retours

Remarques

Jeu d’API : SharedRuntime 1.1, Mailbox 1.10

Cette méthode est disponible dans la configuration requise SharedRuntime 1.1 définie pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises 1.10 pour Outlook.

Important : dans Outlook, la prise en charge n’est disponible qu’avec la fonctionnalité d’activation basée sur les événements implémentée dans Outlook sur Windows. Cette méthode n’est pas prise en charge dans Outlook sur Mac ou sur le web.

Exemples

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

Définit une paire de valeur clé dans le stockage ou met à jour une paire de valeur clé existante. Renvoie une promesse.

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

Paramètres

Retours

Remarques

Jeu d’API : SharedRuntime 1.1, Mailbox 1.10

Cette méthode est disponible dans la configuration requise SharedRuntime 1.1 définie pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises 1.10 pour Outlook.

Important : dans Outlook, la prise en charge n’est disponible qu’avec la fonctionnalité d’activation basée sur les événements implémentée dans Outlook sur Windows. Cette méthode n’est pas prise en charge dans Outlook sur Mac ou sur le web.

Exemples

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

Stocke plusieurs éléments ou met à jour plusieurs éléments qu’il contient. Renvoie une promesse.

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

Paramètres

Retours

Remarques

Jeu d’API : SharedRuntime 1.1, Mailbox 1.10

Cette méthode est disponible dans la configuration requise SharedRuntime 1.1 définie pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises 1.10 pour Outlook.

Important : dans Outlook, la prise en charge n’est disponible qu’avec la fonctionnalité d’activation basée sur les événements implémentée dans Outlook sur Windows. Cette méthode n’est pas prise en charge dans Outlook sur Mac ou sur le web.

Exemples

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