Class FileIterator

FileIterator

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

// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var 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 chamar next() retornará um item.
next()FileAcessa o próximo item da 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 têm validade de uma semana.

Retorno

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 chamar next() retornará um item.

Retorno

Boolean: true se next() retornar um item; false caso não retorne um item.


next()

Acessa o próximo item da coleção de arquivos ou pastas. Lança uma exceção se nenhum item permanecer.

Retorno

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