Class FolderIterator

文件夹迭代器

一个对象,可让脚本迭代可能非常大的文件夹集合。您可以通过 DriveAppFileFolder 访问文件夹迭代器。

// Log the name of every folder in the user's Drive.
const folders = DriveApp.getFolders();
while (folders.hasNext()) {
  const folder = folders.next();
  Logger.log(folder.getName());
}

方法

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

详细文档

getContinuationToken()

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

返回

String - 一个接续令牌,可用于使用令牌生成时迭代器中保留的项来继续此迭代


hasNext()

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

返回

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


next()

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

返回

Folder - 集合中的下一项