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

Class FolderIterator

Objet permettant aux scripts d'effectuer des itérations sur une collection de dossiers potentiellement volumineuse. Dossier Les itérateurs sont accessibles à partir de DriveApp, File ou Folder.

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.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()`	`Folder`	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 exécution entraîne le dépassement du 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 restait dans l'itérateur lorsque le jeton a été généré.

`hasNext()`

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

Renvois

Boolean : true si next() renvoie un article. false si ce n'est pas le cas

`next()`

Récupère l'élément suivant dans la collection de fichiers ou de dossiers. Une exception est générée si aucun élément n'est spécifié. restent.

Renvois

Folder : élément suivant dans la collection