Share via

OfficeRuntime.Storage interface

  • Referência
Pacote:
office-runtime

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

Comentários

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

Essa interface está disponível no conjunto de requisitos SharedRuntime 1.1 para suplementos do Excel, PowerPoint e Word. Ele 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 o recurso de ativação baseado em eventos implementado no Outlook no Windows. Essa interface não tem suporte no Outlook no Mac ou na Web.

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

Métodos

getItem(key)

Recupera um item do armazenamento com base em sua chave. Retorna uma promessa. No caso de a Promessa não resolve, retorna nulo.
getItems(keys)

Recupera vários itens do armazenamento com base em sua chave. Retorna uma promessa. No caso de a Promessa não resolve, retorna nulo.
getKeys()

Recupera uma matriz de todas as chaves do armazenamento. Retorna uma promessa.
removeItem(key)

Remove um item do armazenamento com base em sua chave. Retorna uma promessa.
removeItems(keys)

Remove vários itens do armazenamento. Retorna uma promessa.
setItem(key, value)

Define um par de valor-chave no armazenamento ou atualiza um par de chave-valor existente. Retorna uma promessa.
setItems(keyValues)

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

Detalhes do método

getItem(key)

Recupera um item do armazenamento com base em sua chave. Retorna uma promessa. No caso de a Promessa não resolve, retorna nulo.

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

Parâmetros

key

string

Chave do item a ser recuperado. Deve ser uma cadeia de caracteres.

Retornos

Promise<string | null>

Comentários

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

Esse método está disponível nos suplementos sharedRuntime 1.1 para Excel, PowerPoint e Word. Ele 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 o recurso de ativação baseado em eventos implementado no Outlook no Windows. Esse método não tem suporte no Outlook no Mac ou na Web.

getItems(keys)

Recupera vários itens do armazenamento com base em sua chave. Retorna uma promessa. No caso de a Promessa não resolve, retorna nulo.

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

Parâmetros

keys

string[]

Chaves de itens a serem removidos. Deve ser uma matriz de cadeias de caracteres.

Retornos

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

Comentários

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

Esse método está disponível nos suplementos sharedRuntime 1.1 para Excel, PowerPoint e Word. Ele 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 o recurso de ativação baseado em eventos implementado no Outlook no Windows. Esse método não tem suporte no Outlook no Mac ou na Web.

getKeys()

Recupera uma matriz de todas as chaves do armazenamento. Retorna uma promessa.

getKeys(): Promise<string[]>;

Retornos

Promise<string[]>

Comentários

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

Esse método está disponível nos suplementos sharedRuntime 1.1 para Excel, PowerPoint e Word. Ele 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 o recurso de ativação baseado em eventos implementado no Outlook no Windows. Esse método não tem suporte no Outlook no Mac ou na Web.

removeItem(key)

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

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

Parâmetros

key

string

Chave do item a ser removido. Deve ser uma cadeia de caracteres.

Retornos

Promise<void>

Comentários

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

Esse método está disponível nos suplementos sharedRuntime 1.1 para Excel, PowerPoint e Word. Ele 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 o recurso de ativação baseado em eventos implementado no Outlook no Windows. Esse método não tem suporte no Outlook no Mac ou na Web.

removeItems(keys)

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

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

Parâmetros

keys

string[]

Chaves de itens a serem removidos. Deve ser uma matriz de cadeias de caracteres.

Retornos

Promise<void>

Comentários

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

Esse método está disponível nos suplementos sharedRuntime 1.1 para Excel, PowerPoint e Word. Ele 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 o recurso de ativação baseado em eventos implementado no Outlook no Windows. Esse método não tem suporte no Outlook no Mac ou na Web.

setItem(key, value)

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

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

Parâmetros

key

string

Chave do item a ser definido. Deve ser uma cadeia de caracteres.

value

string

Deve ser uma cadeia de caracteres.

Retornos

Promise<void>

Comentários

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

Esse método está disponível nos suplementos sharedRuntime 1.1 para Excel, PowerPoint e Word. Ele 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 o recurso de ativação baseado em eventos implementado no Outlook no Windows. Esse método não tem suporte no Outlook no Mac ou na Web.

setItems(keyValues)

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

keyValues

{ [key: string]: string }

Pares de valor-chave a serem definidos. Devem ser cadeias de caracteres.

Retornos

Promise<void>

Comentários

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

Esse método está disponível nos suplementos sharedRuntime 1.1 para Excel, PowerPoint e Word. Ele 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 o recurso de ativação baseado em eventos implementado no Outlook no Windows. Esse método não tem suporte no Outlook no Mac ou na Web.