Class FolderIterator
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Itérateurde dossier
Objet permettant aux scripts d'itérer sur une collection potentiellement importante de dossiers. Les itérateurs de dossiers sont accessibles à partir 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éthodes
| Méthode | Type renvoyé | Brève description |
getContinuationToken() | String | Récupère un jeton pouvant être utilisé pour reprendre cette itération ultérieurement. |
hasNext() | Boolean | Détermine si l'appel de next() renvoie un élément. |
next() | Folder | Récupère l'élément suivant de la collection de fichiers ou de dossiers. |
Documentation détaillée
getContinuationToken()
Récupère un jeton pouvant être utilisé pour reprendre cette itération ultérieurement. Cette méthode est utile si le traitement d'un itérateur en une seule exécution dépasserait le temps d'exécution maximal.
Les jetons de continuation sont généralement valides pendant une semaine.
Renvois
String : jeton de continuation qui peut être utilisé pour reprendre cette itération avec les éléments qui sont restés dans l'itérateur lorsque le jeton a été généré
hasNext()
Détermine si l'appel de next() renvoie un élément.
Renvois
Boolean : true si next() renvoie un élément, false sinon
next()
Récupère l'élément suivant de la collection de fichiers ou de dossiers. Génère une exception si aucun élément ne reste.
Renvois
Folder : élément suivant de la collection
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 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"]]
