Class FolderIterator
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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étodo | Tipo de retorno | Breve descrição |
getContinuationToken() | String | Recebe um token que pode ser usado para retomar essa iteração mais tarde. |
hasNext() | Boolean | Determina se a chamada de next() vai retornar um item. |
next() | Folder | Recebe 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
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003e\u003ccode\u003eFolderIterator\u003c/code\u003e enables scripts to iterate through a large collection of folders within Google Drive.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods like \u003ccode\u003ehasNext()\u003c/code\u003e to check for more folders, \u003ccode\u003enext()\u003c/code\u003e to retrieve the next folder, and \u003ccode\u003egetContinuationToken()\u003c/code\u003e for handling lengthy iterations.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize \u003ccode\u003eFolderIterator\u003c/code\u003e with \u003ccode\u003eDriveApp\u003c/code\u003e, \u003ccode\u003eFile\u003c/code\u003e, or \u003ccode\u003eFolder\u003c/code\u003e objects to access and process folders programmatically.\u003c/p\u003e\n"]]],["FolderIterator allows iterating over a large collection of folders. Key actions include using `hasNext()` to check for the next item and `next()` to retrieve it. `getContinuationToken()` provides a token to resume iteration later, helpful for large collections. The example shows how to log every folder's name in a user's Drive, demonstrating iteration through the folder collection. The iterator returns folder objects and can throw an exception if no items remain.\n"],null,["# Class FolderIterator\n\nFolderIterator\n\nAn object that allows scripts to iterate over a potentially large collection of folders. Folder\niterators can be accessed from [DriveApp](/apps-script/reference/drive/drive-app), a [File](/apps-script/reference/drive/file), or a [Folder](/apps-script/reference/drive/folder).\n\n```javascript\n// Log the name of every folder in the user's Drive.\nconst folders = DriveApp.getFolders();\nwhile (folders.hasNext()) {\n const folder = folders.next();\n Logger.log(folder.getName());\n}\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------|-----------------------------------------------|-------------------------------------------------------------------------|\n| [getContinuationToken()](#getContinuationToken()) | `String` | Gets a token that can be used to resume this iteration at a later time. |\n| [hasNext()](#hasNext()) | `Boolean` | Determines whether calling [next()](#next()) will return an item. |\n| [next()](#next()) | [Folder](/apps-script/reference/drive/folder) | Gets the next item in the collection of files or folders. |\n\nDetailed documentation\n----------------------\n\n### `get``Continuation``Token()`\n\nGets a token that can be used to resume this iteration at a later time. This method is useful\nif processing an iterator in one execution would exceed the maximum execution time.\nContinuation tokens are generally valid for one week.\n\n#### Return\n\n\n`String` --- a continuation token that can be used to resume this iteration with the items that\nremained in the iterator when the token was generated\n\n*** ** * ** ***\n\n### `has``Next()`\n\nDetermines whether calling [next()](#next()) will return an item.\n\n#### Return\n\n\n`Boolean` --- `true` if [next()](#next()) will return an item; `false` if not\n\n*** ** * ** ***\n\n### `next()`\n\nGets the next item in the collection of files or folders. Throws an exception if no items\nremain.\n\n#### Return\n\n\n[Folder](/apps-script/reference/drive/folder) --- the next item in the collection"]]
