Class FolderIterator

FolderIterator

Um objeto que permite que os scripts façam iterações em uma coleção potencialmente grande de pastas. Os iteradores de pasta podem ser acessados em DriveApp, File ou Folder.

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var 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 chamar next() retornará um item.
next()FolderAcessa 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

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