OfficeRuntime.Storage interface

  • Referência
Pacote:
office-runtime

Armazenamento assíncrono, global e persistente de chave-valor.

Comentários

[ Conjunto de API: SharedRuntime 1.1, Caixa de Correio 1.10 ]

Esta interface está disponível no conjunto de requisitos do SharedRuntime 1.1 para suplementos do Excel, PowerPoint e Word. Também está disponível a partir do conjunto de requisitos da Caixa de Correio 1.10 para o Outlook.

Importante: no Outlook, o suporte só está disponível com a funcionalidade de ativação baseada em eventos implementada no Outlook no Windows. Esta interface não é suportada no Outlook para Mac ou na Web.

O limite de armazenamento é de 10 MB por domínio, o que pode ser partilhado por vários suplementos.

Métodos

getItem(key)

Obtém um item do armazenamento com base na respetiva chave. Devolve uma Promessa. Caso a Promessa não seja resolvida, devolve nulo.
getItems(keys)

Obtém vários itens do armazenamento com base na respetiva chave. Devolve uma Promessa. Caso a Promessa não seja resolvida, devolve nulo.
getKeys()

Obtém uma matriz de todas as chaves do armazenamento. Devolve uma Promessa.
removeItem(key)

Remove um item do armazenamento com base na respetiva chave. Devolve uma Promessa.
removeItems(keys)

Remove vários itens do armazenamento. Devolve uma Promessa.
setItem(key, value)

Define um par chave-valor no armazenamento ou atualiza um par chave-valor existente. Devolve uma Promessa.
setItems(keyValues)

Define múltiplos itens no armazenamento ou atualiza múltiplos itens no armazenamento. Devolve uma Promessa.

Detalhes do método

getItem(key)

Obtém um item do armazenamento com base na respetiva chave. Devolve uma Promessa. Caso a Promessa não seja resolvida, devolve nulo.

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

Parâmetros

key

string

Chave do item a obter. Tem de ser uma cadeia.

Retornos

Promise<string | null>

Comentários

[ Conjunto de API: SharedRuntime 1.1, Caixa de Correio 1.10 ]

Este método está disponível no conjunto de requisitos sharedRuntime 1.1 para suplementos do Excel, PowerPoint e Word. Também está disponível a partir do conjunto de requisitos da Caixa de Correio 1.10 para o Outlook.

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

getItems(keys)

Obtém vários itens do armazenamento com base na respetiva chave. Devolve uma Promessa. Caso a Promessa não seja resolvida, devolve nulo.

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

Parâmetros

keys

string[]

Chaves de itens a serem removidos. Tem de ser uma matriz de cadeias.

Retornos

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

Comentários

[ Conjunto de API: SharedRuntime 1.1, Caixa de Correio 1.10 ]

Este método está disponível no conjunto de requisitos sharedRuntime 1.1 para suplementos do Excel, PowerPoint e Word. Também está disponível a partir do conjunto de requisitos da Caixa de Correio 1.10 para o Outlook.

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

getKeys()

Obtém uma matriz de todas as chaves do armazenamento. Devolve uma Promessa.

getKeys(): Promise<string[]>;

Retornos

Promise<string[]>

Comentários

[ Conjunto de API: SharedRuntime 1.1, Caixa de Correio 1.10 ]

Este método está disponível no conjunto de requisitos sharedRuntime 1.1 para suplementos do Excel, PowerPoint e Word. Também está disponível a partir do conjunto de requisitos da Caixa de Correio 1.10 para o Outlook.

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

removeItem(key)

Remove um item do armazenamento com base na respetiva chave. Devolve uma Promessa.

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

Parâmetros

key

string

Chave do item a ser removido. Tem de ser uma cadeia.

Retornos

Promise<void>

Comentários

[ Conjunto de API: SharedRuntime 1.1, Caixa de Correio 1.10 ]

Este método está disponível no conjunto de requisitos sharedRuntime 1.1 para suplementos do Excel, PowerPoint e Word. Também está disponível a partir do conjunto de requisitos da Caixa de Correio 1.10 para o Outlook.

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

removeItems(keys)

Remove vários itens do armazenamento. Devolve uma Promessa.

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

Parâmetros

keys

string[]

Chaves de itens a serem removidos. Tem de ser uma matriz de cadeias.

Retornos

Promise<void>

Comentários

[ Conjunto de API: SharedRuntime 1.1, Caixa de Correio 1.10 ]

Este método está disponível no conjunto de requisitos sharedRuntime 1.1 para suplementos do Excel, PowerPoint e Word. Também está disponível a partir do conjunto de requisitos da Caixa de Correio 1.10 para o Outlook.

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

setItem(key, value)

Define um par chave-valor no armazenamento ou atualiza um par chave-valor existente. Devolve uma Promessa.

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

Parâmetros

key

string

Chave do item a ser definido. Tem de ser uma cadeia.

value

string

Tem de ser uma cadeia.

Retornos

Promise<void>

Comentários

[ Conjunto de API: SharedRuntime 1.1, Caixa de Correio 1.10 ]

Este método está disponível no conjunto de requisitos sharedRuntime 1.1 para suplementos do Excel, PowerPoint e Word. Também está disponível a partir do conjunto de requisitos da Caixa de Correio 1.10 para o Outlook.

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

setItems(keyValues)

Define múltiplos itens no armazenamento ou atualiza múltiplos itens no armazenamento. Devolve uma Promessa.

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

Parâmetros

keyValues

{ [key: string]: string }

Pares chave-valor a definir. Têm de ser cadeias de carateres.

Retornos

Promise<void>

Comentários

[ Conjunto de API: SharedRuntime 1.1, Caixa de Correio 1.10 ]

Este método está disponível no conjunto de requisitos sharedRuntime 1.1 para suplementos do Excel, PowerPoint e Word. Também está disponível a partir do conjunto de requisitos da Caixa de Correio 1.10 para o Outlook.

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