Class FileIterator

FileIterator

Il s'agit d'un itérateur qui permet aux scripts d'itérer sur une collection de fichiers potentiellement volumineuse. Les itérateurs de fichiers sont accessibles depuis DriveApp ou un 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());
}

Méthodes

MéthodeType renvoyéBrève description
getContinuationToken()StringObtient un jeton qui peut être utilisé pour reprendre cette itération ultérieurement.
hasNext()BooleanDétermine si l'appel de next() renvoie un élément.
next()FileObtient l'élément suivant dans la collection de fichiers ou de dossiers.

Documentation détaillée

getContinuationToken()

Obtient un jeton qui peut être utilisé pour reprendre cette itération ultérieurement. Cette méthode est utile si le traitement d'un itérateur en une seule exécution dépasse le temps d'exécution maximal. Les jetons de continuation sont généralement valides pendant une semaine.

Renvois

String : jeton de continuation qui peut être utilisé pour reprendre cette itération avec les éléments restants dans l'itérateur lorsque le jeton a été généré.

hasNext()

Détermine si l'appel de next() renvoie un élément.

Renvois

Boolean : true si next() renvoie un élément, false sinon.

next()

Obtient l'élément suivant dans la collection de fichiers ou de dossiers. Génère une exception si aucun élément ne reste.

Renvois

File : l'élément suivant de la collection.