Class FolderIterator

FolderIterator

An object that allows scripts to iterate over a potentially large collection of folders. Folder iterators can be accessed from DriveApp, a File, or a 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());
}

Methods

MethodReturn typeBrief description
getContinuationToken()StringGets a token that can be used to resume this iteration at a later time.
hasNext()BooleanDetermines whether calling next() 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 useful if 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 calling next() will return an item.

Return

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

next()

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

Return

Folder — the next item in the collection