Class FileIterator

FileIterator

Iterator, który umożliwia skryptom iterowanie po potencjalnie dużym zbiorze plików. Do iteratorów plików można uzyskać dostęp z poziomu DriveApp lub 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());
}

Metody

MetodaZwracany typKrótki opis
getContinuationToken()StringPobiera token, którego można użyć do wznowienia tej iteracji w późniejszym czasie.
hasNext()BooleanOkreśla, czy wywołanie funkcji next() zwraca element.
next()FilePobiera następny element w kolekcji plików lub folderów.

Szczegółowa dokumentacja

getContinuationToken()

Pobiera token, którego można użyć do wznowienia tej iteracji w późniejszym czasie. Ta metoda jest przydatna, jeśli przetwarzanie iteratora w jednym wykonaniu przekracza maksymalny czas wykonania. Tokeny kontynuacji są zwykle ważne przez tydzień.

Powrót

String – token kontynuacji, którego można użyć do wznowienia tej iteracji z elementami, które pozostały w iteratorze w momencie wygenerowania tokena.


hasNext()

Określa, czy wywołanie funkcji next() zwraca element.

Powrót

Boolean – true, jeśli next() zwraca element; false w przeciwnym razie.


next()

Pobiera następny element w kolekcji plików lub folderów. Zgłasza wyjątek, jeśli nie ma już żadnych elementów.

Powrót

File – następny element w kolekcji.