Class FolderIterator

FolderIterator

Um objeto que permite que os scripts iterem em uma coleção potencialmente grande de pastas. Os iteradores de pastas podem ser acessados de DriveApp, File ou Folder.

// Log the name of every folder in the user's Drive.
const folders = DriveApp.getFolders();
while (folders.hasNext()) {
  const folder = folders.next();
  Logger.log(folder.getName());
}

Métodos

MétodoTipo de retornoBreve descrição
getContinuationToken()StringRecebe um token que pode ser usado para retomar essa iteração mais tarde.
hasNext()BooleanDetermina se a chamada de next() vai retornar um item.
next()FolderRecebe o próximo item na coleção de arquivos ou pastas.

Documentação detalhada

getContinuationToken()

Recebe um token que pode ser usado para retomar essa iteração mais tarde. Esse método é útil se o processamento de um iterador em uma execução exceder o tempo máximo de execução. Os tokens de continuação geralmente são válidos por uma semana.

Retornar

String: um token de continuação que pode ser usado para retomar essa iteração com os itens que permaneceram no iterador quando o token foi gerado.


hasNext()

Determina se a chamada de next() vai retornar um item.

Retornar

Boolean: true se next() retornar um item; false, caso contrário.


next()

Recebe o próximo item na coleção de arquivos ou pastas. Gera uma exceção se nenhum item permanecer.

Retornar

Folder: o próximo item da coleção