Cette page a été traduite par l'API Cloud Translation.

Class FolderIterator

Objet permettant aux scripts d'itérer sur une collection potentiellement importante de dossiers. Les itérateurs de dossiers sont accessibles à partir de DriveApp, File ou Folder.

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

Méthodes

Méthode	Type renvoyé	Brève description
`getContinuationToken()`	`String`	Récupère un jeton pouvant être utilisé pour reprendre cette itération ultérieurement.
`hasNext()`	`Boolean`	Détermine si l'appel de `next()` renvoie un élément.
`next()`	`Folder`	Récupère l'élément suivant de la collection de fichiers ou de dossiers.

Documentation détaillée

`getContinuationToken()`

Récupère un jeton pouvant ê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épasserait 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 qui sont restés 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()`

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

Renvois

Folder : élément suivant de la collection