OfficeRuntime.Storage interface

Paquete:

office-runtime

Almacenamiento de clave-valor asincrónico, global y persistente.

Comentarios

[ Conjunto de API: SharedRuntime 1.1, Mailbox 1.10 ]

Esta interfaz está disponible en el conjunto de requisitos 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. Esta interfaz no se admite en Outlook en Mac o en la web.

El límite de almacenamiento es de 10 MB por dominio, que pueden compartir varios complementos.

Métodos

getItem(key)	Recupera un elemento del almacenamiento en función de su clave. Devuelve una promesa. En caso de que la promesa no se resuelva, devuelve null.
getItems(keys)	Recupera varios elementos del almacenamiento en función de su clave. Devuelve una promesa. En caso de que la promesa no se resuelva, devuelve null.
getKeys()	Recupera una matriz de todas las claves del almacenamiento. Devuelve una promesa.
removeItem(key)	Quita un elemento del almacenamiento en función de su clave. Devuelve una promesa.
removeItems(keys)	Quita varios elementos del almacenamiento. Devuelve una promesa.
setItem(key, value)	Establece un par clave-valor en el almacenamiento o actualiza un par clave-valor existente. Devuelve una promesa.
setItems(keyValues)	Establece varios elementos en el almacenamiento o actualiza varios elementos dentro del almacenamiento. Devuelve una promesa.

Detalles del método

getItem(key)

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

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

Parámetros

key

string

Clave del elemento que se va a recuperar. Debe ser una cadena.

Devoluciones

Promise<string | null>

Comentarios

[ Conjunto de API: SharedRuntime 1.1, Mailbox 1.10 ]

Este método está disponible en el conjunto de requisitos SharedRuntime 1.1 para Excel, PowerPoint y Word complementos. 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 se admite en Outlook en Mac o en la web.

getItems(keys)

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

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

Parámetros

keys

string[]

Claves de elementos que se van a quitar. Debe ser una matriz de cadenas.

Devoluciones

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

Comentarios

[ Conjunto de API: SharedRuntime 1.1, Mailbox 1.10 ]

Este método está disponible en el conjunto de requisitos SharedRuntime 1.1 para Excel, PowerPoint y Word complementos. 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 se admite en Outlook en Mac o en la web.

getKeys()

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

getKeys(): Promise<string[]>;

Devoluciones

Promise<string[]>

Comentarios

[ Conjunto de API: SharedRuntime 1.1, Mailbox 1.10 ]

Este método está disponible en el conjunto de requisitos SharedRuntime 1.1 para Excel, PowerPoint y Word complementos. 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 se admite en Outlook en Mac o en la web.

removeItem(key)

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

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

Parámetros

key

string

Clave del elemento que se va a quitar. Debe ser una cadena.

Devoluciones

Promise<void>

Comentarios

[ Conjunto de API: SharedRuntime 1.1, Mailbox 1.10 ]

Este método está disponible en el conjunto de requisitos SharedRuntime 1.1 para Excel, PowerPoint y Word complementos. 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 se admite en Outlook en Mac o en la web.

removeItems(keys)

Quita varios elementos del almacenamiento. Devuelve una promesa.

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

Parámetros

keys

string[]

Claves de elementos que se van a quitar. Debe ser una matriz de cadenas.

Devoluciones

Promise<void>

Comentarios

[ Conjunto de API: SharedRuntime 1.1, Mailbox 1.10 ]

Este método está disponible en el conjunto de requisitos SharedRuntime 1.1 para Excel, PowerPoint y Word complementos. 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 se admite en Outlook en Mac o en la web.

setItem(key, value)

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

key

string

Clave del elemento que se va a establecer. Debe ser una cadena.

value

string

Debe ser una cadena.

Devoluciones

Promise<void>

Comentarios

[ Conjunto de API: SharedRuntime 1.1, Mailbox 1.10 ]

Este método está disponible en el conjunto de requisitos SharedRuntime 1.1 para Excel, PowerPoint y Word complementos. 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 se admite en Outlook en Mac o en la web.

setItems(keyValues)

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

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

Parámetros

keyValues

{ [key: string]: string }

Pares clave-valor que se van a establecer. Deben ser cadenas.

Devoluciones

Promise<void>

Comentarios

[ Conjunto de API: SharedRuntime 1.1, Mailbox 1.10 ]

Este método está disponible en el conjunto de requisitos SharedRuntime 1.1 para Excel, PowerPoint y Word complementos. 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 se admite en Outlook en Mac o en la web.