Interface 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());
}

interface FileIterator {
    getContinuationToken(): string;
    hasNext(): boolean;
    next(): GoogleAppsScript.Drive.File;
}

Index

Methods

getContinuationToken hasNext next

Methods

getContinuationToken

getContinuationToken(): string
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.

Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:253

hasNext

hasNext(): boolean
Determines whether calling next() will return an item.

Returns boolean
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:255

next(): GoogleAppsScript.Drive.File
Gets the next item in the collection of files or folders. Throws an exception if no items remain.

Returns GoogleAppsScript.Drive.File
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:260

Interface FileIterator

Index

Methods

Methods

getContinuationToken

Returns string

hasNext

Returns boolean

next

Returns GoogleAppsScript.Drive.File

Settings

On This Page