Class FolderIterator

  • FolderIterator allows scripts to iterate over potentially large collections of folders.

  • Folder iterators can be accessed from DriveApp, a File, or a Folder.

  • Key methods includegetContinuationToken(),hasNext(), andnext().

FolderIterator

An object that allows scripts to iterate over a potentially large collection of folders. Folderiterators can be accessed fromDriveApp, aFile, or aFolder.

// Log the name of every folder in the user's Drive.constfolders=DriveApp.getFolders();while(folders.hasNext()){constfolder=folders.next();Logger.log(folder.getName());}

Methods

MethodReturn typeBrief description
getContinuationToken()StringGets a token that can be used to resume this iteration at a later time.
hasNext()BooleanDetermines whether callingnext() will return an item.
next()FolderGets the next item in the collection of files or folders.

Detailed documentation

getContinuationToken()

Gets a token that can be used to resume this iteration at a later time. This method is usefulif processing an iterator in one execution would exceed the maximum execution time.Continuation tokens are generally valid for one week.

Return

String — a continuation token that can be used to resume this iteration with the items that remained in the iterator when the token was generated

hasNext()

Determines whether callingnext() will return an item.

Return

Boolean —true ifnext() will return an item;false if not

next()

Gets the next item in the collection of files or folders. Throws an exception if no itemsremain.

Return

Folder — the next item in the collection

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-11 UTC.