Class FileIterator

FileIterator

スクリプトが大量のファイル コレクションを反復処理できるようにするイテレータ。ファイル イテレータには、DriveApp または 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());
}

メソッド

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

詳細なドキュメント

getContinuationToken()

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

戻る

String - トークンが生成されたときにイテレータに残っていたアイテムを使用して、このイテレーションを再開するために使用できる継続トークン。

hasNext()

next() の呼び出しでアイテムが返されるかどうかを判断します。

戻る

Boolean - next() がアイテムを返す場合は true、それ以外の場合は false。

next()

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

戻る

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