Class FileIterator

Файловый итератор

Итератор, позволяющий скриптам перебирать потенциально большую коллекцию файлов. Доступ к файловым итераторам можно получить из Drive App или 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());
}

Методы

Метод Тип возвращаемого значения Краткое описание
get Continuation Token() String Получает токен, который можно использовать для возобновления этой итерации позже.
has Next() Boolean Определяет, возвращает ли вызов функции next() элемент.
next() File Получает следующий элемент в коллекции файлов или папок.

Подробная документация

get Continuation Token()

Получает токен, который можно использовать для возобновления этой итерации позже. Этот метод полезен, если обработка итератора за один запуск превышает максимальное время выполнения. Токены для продолжения обычно действительны в течение одной недели.

Возвращаться

String — Токен продолжения, который можно использовать для возобновления данной итерации с элементами, оставшимися в итераторе на момент генерации токена.

has Next()

Определяет, возвращает ли вызов функции next() элемент.

Возвращаться

Boolean — true если next() возвращает элемент; false если нет.

next()

Получает следующий элемент в коллекции файлов или папок. Генерирует исключение, если элементов не осталось.

Возвращаться

File — Следующий элемент в коллекции.