Class FileIterator

FileIterator

一种迭代器,允许脚本遍历可能包含大量文件的集合。您可以从 DriveAppFolder 访问文件迭代器。

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

方法

方法返回值类型简介
getContinuationToken()String获取一个令牌,该令牌可用于稍后恢复此迭代。
hasNext()Boolean确定调用 next() 是否会返回项。
next()File获取文件或文件夹集合中的下一项。

详细文档

getContinuationToken()

获取一个令牌,该令牌可用于稍后恢复此迭代。如果在一个执行中处理迭代器时超出最长执行时间,此方法会非常有用。续传令牌的有效期通常为一周。

返回

String - 续传令牌,可用于恢复此迭代,并包含生成令牌时迭代器中剩余的项。


hasNext()

确定调用 next() 是否会返回项。

返回

Boolean - 如果 next() 返回项,则为 true;否则为 false


next()

获取文件或文件夹集合中的下一项。如果没有任何剩余项,则抛出异常。

返回

File - 集合中的下一项。