Page Summary
-
FileIterator allows scripts to iterate over potentially large collections of files.
-
File iterators can be accessed from DriveApp or a Folder.
-
The
hasNext()method determines if there are more files to iterate over. -
The
next()method retrieves the next file in the collection. -
The
getContinuationToken()method provides a token to resume iteration later.
An iterator that allows scripts to iterate over a potentially large collection of files. File
iterators can be accessed from DriveApp
or a Folder
.
// Log the name of every file in the user's Drive. const files = DriveApp . getFiles (); while ( files . hasNext ()) { const file = files . next (); Logger . log ( file . getName ()); }
Methods
| Method | Return type | Brief description |
|---|---|---|
String
|
Gets a token that can be used to resume this iteration at a later time. | |
Boolean
|
Determines whether calling next()
returns an item. |
|
File
|
Gets 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 exceeds 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()
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.
