Class FileIterator

FileIterator

Um iterador que permite que os scripts iterem em uma coleção de arquivos potencialmente grande. Os iteradores de arquivos podem ser acessados no DriveApp ou em uma Folder.

// Log the name of every file in the user's Drive.
const files = DriveApp.getFiles();
while (files.hasNext()) {
  const file = files.next();
  Logger.log(file.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() retorna um item.
next()FileRecebe 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() retorna 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 não houver mais itens.

Retornar

File: o próximo item da coleção.