Class CacheService

CacheService

O CacheService permite acessar um cache para armazenamento de dados de curto prazo.

Essa classe permite receber uma instância de cache específica. Os caches públicos são para itens que não dependem de qual usuário está acessando seu script. Os caches privados são para coisas que são específicas do usuário, como configurações ou atividade recente.

Não há garantia de que os dados gravados no cache vão persistir até o tempo de expiração. Você precisa estar preparado para receber null de volta de todas as leituras.

Métodos

MétodoTipo de retornoBreve descrição
getDocumentCache()Cache|nullRecebe a instância de cache com escopo definido para o documento e o script atuais.
getScriptCache()CacheRecebe a instância de cache com escopo definido para o script.
getUserCache()CacheRecebe a instância de cache com escopo definido para o usuário e o script atuais.

Documentação detalhada

getDocumentCache()

Recebe a instância de cache com escopo definido para o documento e o script atuais. Os caches de documentos são específicos do documento atual que contém o script. Use-as para armazenar informações de script específicas do documento atual. Se esse método for chamado fora do contexto de um documento que o contenha (como um script independente ou um app da Web), ele vai retornar null.

// Gets a cache that is specific to the current document containing the script
const cache = CacheService.getDocumentCache();

Retornar

Cache|null: uma instância de cache de documento ou null se não houver um documento contido.


getScriptCache()

Recebe a instância de cache com escopo definido para o script. Os caches de script são comuns a todos os usuários do script. Use-os para armazenar informações que não são específicas do usuário atual.

// Gets a cache that is common to all users of the script
const cache = CacheService.getScriptCache();

Retornar

Cache: uma instância de cache de script.


getUserCache()

Recebe a instância de cache com escopo definido para o usuário e o script atuais. Os caches de usuário são específicos do usuário atual do script. Use-os para armazenar informações de script específicas do usuário atual.

// Gets a cache that is specific to the current user of the script
const cache = CacheService.getUserCache();

Retornar

Cache: uma instância de cache do usuário