Class CacheService

CacheService

CacheService permite que você acesse um cache para armazenamento de dados de curto prazo.

Essa classe permite acessar uma instância de cache específica. Caches públicos são usados em coisas que não dependem de qual usuário acessa o script. Os caches privados servem para itens específicos 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 prazo de validade. Você precisa estar preparado para receber null de todas as leituras.

Métodos

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

Documentação detalhada

getDocumentCache()

Recebe a instância de cache com escopo para o documento e 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 contém (como em um script independente ou app da Web), esse método retornará null.

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

Retorno

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


getScriptCache()

Recebe a instância de cache com escopo 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
var cache = CacheService.getScriptCache();

Retorno

Cache: uma instância de cache de script.


getUserCache()

Recebe a instância de cache com escopo para o usuário e script atuais. Os caches do 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
var cache = CacheService.getUserCache();

Retorno

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