Class FolderIterator

FolderIterator

Objet permettant aux scripts d'itérer une collection potentiellement importante de dossiers. Les itérateurs de dossier 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éthodeType renvoyéBrève description
getContinuationToken()StringRécupère un jeton qui peut être utilisé pour reprendre cette itération ultérieurement.
hasNext()BooleanDétermine si l'appel de next() renvoie un article.
next()FolderRé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()

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

Renvois

Boolean : true si next() renvoie un article ; false dans le cas contraire.


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

Folder : élément suivant de la collection