Class FolderIterator

FolderIterator

大量のフォルダが存在する可能性があるコレクションに対してスクリプトで反復処理を行えるオブジェクト。フォルダ イテレータには、DriveAppFile、または Folder からアクセスできます。

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

Methods

メソッド戻り値の型概要
getContinuationToken()Stringこの反復処理を後で再開するために使用できるトークンを取得します。
hasNext()Booleannext() を呼び出してアイテムを返すかどうかを決定します。
next()Folderファイルまたはフォルダのコレクション内の次のアイテムを取得します。

詳細なドキュメント

getContinuationToken()

この反復処理を後で再開するために使用できるトークンを取得します。このメソッドは、1 回の実行でイテレータの処理が最大実行時間を超える場合に便利です。継続トークンは通常 1 週間有効です。

リターン

String - トークンの生成時にイテレータに残ったアイテムでイテレーションを再開するために使用できる継続トークン。


hasNext()

next() を呼び出してアイテムを返すかどうかを決定します。

リターン

Boolean - next() が商品を返品する場合は true、返品しない場合は false


next()

ファイルまたはフォルダのコレクション内の次のアイテムを取得します。アイテムが残っていない場合は、例外がスローされます。

リターン

Folder - コレクション内の次のアイテム