Itérateur permettant aux scripts d'itérer une collection de fichiers potentiellement volumineuse. Les itérateurs de fichiers sont accessibles à partir de DriveApp
ou d'un Folder
.
// Log the name of every file in the user's Drive. var files = DriveApp.getFiles(); while (files.hasNext()) { var file = files.next(); Logger.log(file.getName()); }
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getContinuationToken() | String | Récupère un jeton qui peut être utilisé pour reprendre cette itération ultérieurement. |
hasNext() | Boolean | Détermine si l'appel de next() renvoie un article. |
next() | File | Récupère l'élément suivant dans la collection de fichiers ou de dossiers. |
Documentation détaillée
getContinuationToken()
Récupère 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 la durée maximale d'exécution. 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 lors de la génération du jeton.
hasNext()
next()
Récupère l'élément suivant dans la collection de fichiers ou de dossiers. Génère une exception s'il ne reste aucun élément.
Renvois
File
: élément suivant de la collection