Class FileIterator

FileIterator

An iterator that allows scripts to iterate over a potentially large collection of files. File iterators can be acccessed from DriveApp or a Folder.

 // Log the name of every file in the user's Drive.
 var files = DriveApp.getFiles();
 while (files.hasNext()) {
   var file = files.next();
   Logger.log(file.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()FileGets 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

Booleantrue 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

File — the next item in the collection

Send feedback about...

Apps Script
Apps Script