Partager via

OfficeRuntime.Storage interface

  • Référence
Paquet:
office-runtime

Stockage clé-valeur asynchrone, global et persistant.

Remarques

[ Ensemble d’API : SharedRuntime 1.1, Mailbox 1.10 ]

Cette interface est disponible dans l’ensemble de conditions requises SharedRuntime 1.1 pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises pour la boîte aux lettres 1.10 pour Outlook.

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

La limite de stockage est de 10 Mo par domaine, qui peut être partagée par plusieurs compléments.

Méthodes

getItem(key)

Récupère un élément du stockage en fonction de sa clé. Retourne une promesse. Dans le cas où la promesse ne se résout pas, retourne null.
getItems(keys)

Récupère plusieurs éléments du stockage en fonction de leur clé. Retourne une promesse. Dans le cas où la promesse ne se résout pas, retourne null.
getKeys()

Récupère un tableau de toutes les clés du stockage. Retourne une promesse.
removeItem(key)

Supprime un élément du stockage en fonction de sa clé. Retourne une promesse.
removeItems(keys)

Supprime plusieurs éléments du stockage. Retourne une promesse.
setItem(key, value)

Définit une paire clé-valeur dans le stockage ou met à jour une paire clé-valeur existante. Retourne une promesse.
setItems(keyValues)

Définit plusieurs éléments dans le stockage ou met à jour plusieurs éléments dans le stockage. Retourne une promesse.

Détails de la méthode

getItem(key)

Récupère un élément du stockage en fonction de sa clé. Retourne une promesse. Dans le cas où la promesse ne se résout pas, retourne null.

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

Paramètres

key

string

Clé de l’élément à récupérer. Doit être une chaîne.

Retours

Promise<string | null>

Remarques

[ Ensemble d’API : SharedRuntime 1.1, Mailbox 1.10 ]

Cette méthode est disponible dans l’ensemble de conditions requises SharedRuntime 1.1 pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises pour la boîte aux lettres 1.10 pour Outlook.

Important : Dans Outlook, la prise en charge est disponible uniquement 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.

getItems(keys)

Récupère plusieurs éléments du stockage en fonction de leur clé. Retourne une promesse. Dans le cas où la promesse ne se résout pas, retourne null.

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

Paramètres

keys

string[]

Clés des éléments à supprimer. Doit être un tableau de chaînes.

Retours

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

Remarques

[ Ensemble d’API : SharedRuntime 1.1, Mailbox 1.10 ]

Cette méthode est disponible dans l’ensemble de conditions requises SharedRuntime 1.1 pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises pour la boîte aux lettres 1.10 pour Outlook.

Important : Dans Outlook, la prise en charge est disponible uniquement 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.

getKeys()

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

getKeys(): Promise<string[]>;

Retours

Promise<string[]>

Remarques

[ Ensemble d’API : SharedRuntime 1.1, Mailbox 1.10 ]

Cette méthode est disponible dans l’ensemble de conditions requises SharedRuntime 1.1 pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises pour la boîte aux lettres 1.10 pour Outlook.

Important : Dans Outlook, la prise en charge est disponible uniquement 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.

removeItem(key)

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

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

Paramètres

key

string

Clé de l’élément à supprimer. Doit être une chaîne.

Retours

Promise<void>

Remarques

[ Ensemble d’API : SharedRuntime 1.1, Mailbox 1.10 ]

Cette méthode est disponible dans l’ensemble de conditions requises SharedRuntime 1.1 pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises pour la boîte aux lettres 1.10 pour Outlook.

Important : Dans Outlook, la prise en charge est disponible uniquement 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.

removeItems(keys)

Supprime plusieurs éléments du stockage. Retourne une promesse.

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

Paramètres

keys

string[]

Clés des éléments à supprimer. Doit être un tableau de chaînes.

Retours

Promise<void>

Remarques

[ Ensemble d’API : SharedRuntime 1.1, Mailbox 1.10 ]

Cette méthode est disponible dans l’ensemble de conditions requises SharedRuntime 1.1 pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises pour la boîte aux lettres 1.10 pour Outlook.

Important : Dans Outlook, la prise en charge est disponible uniquement 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.

setItem(key, value)

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

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

Paramètres

key

string

Clé de l’élément à définir. Doit être une chaîne.

value

string

Doit être une chaîne.

Retours

Promise<void>

Remarques

[ Ensemble d’API : SharedRuntime 1.1, Mailbox 1.10 ]

Cette méthode est disponible dans l’ensemble de conditions requises SharedRuntime 1.1 pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises pour la boîte aux lettres 1.10 pour Outlook.

Important : Dans Outlook, la prise en charge est disponible uniquement 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.

setItems(keyValues)

Définit plusieurs éléments dans le stockage ou met à jour plusieurs éléments dans le stockage. Retourne une promesse.

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

Paramètres

keyValues

{ [key: string]: string }

Paires clé-valeur à définir. Doit être des chaînes.

Retours

Promise<void>

Remarques

[ Ensemble d’API : SharedRuntime 1.1, Mailbox 1.10 ]

Cette méthode est disponible dans l’ensemble de conditions requises SharedRuntime 1.1 pour les compléments Excel, PowerPoint et Word. Il est également disponible à partir de l’ensemble de conditions requises pour la boîte aux lettres 1.10 pour Outlook.

Important : Dans Outlook, la prise en charge est disponible uniquement 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.