Class FolderIterator
FolderIterator
Um objeto que permite que os scripts iterem em uma coleção potencialmente grande de pastas. Os iteradores
de pastas podem ser acessados 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étodos
| Método | Tipo de retorno | Breve descrição |
getContinuationToken() | String | Recebe um token que pode ser usado para retomar essa iteração mais tarde. |
hasNext() | Boolean | Determina se a chamada de next() vai retornar um item. |
next() | Folder | Recebe o próximo item na coleção de arquivos ou pastas. |
Documentação detalhada
getContinuationToken()
Recebe um token que pode ser usado para retomar essa iteração mais tarde. Esse método é útil
se o processamento de um iterador em uma execução exceder o tempo máximo de execução.
Os tokens de continuação geralmente são válidos por uma semana.
Retornar
String: um token de continuação que pode ser usado para retomar essa iteração com os itens que
permaneceram no iterador quando o token foi gerado.
hasNext()
Determina se a chamada de next() vai retornar um item.
Retornar
Boolean: true se next() retornar um item; false, caso contrário.
next()
Recebe o próximo item na coleção de arquivos ou pastas. Gera uma exceção se nenhum item
permanecer.
Retornar
Folder: o próximo item da coleção
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-12-22 UTC.
[null,null,["Última atualização 2024-12-22 UTC."],[[["`FolderIterator` enables scripts to iterate through a large collection of folders within Google Drive."],["It provides methods like `hasNext()` to check for more folders, `next()` to retrieve the next folder, and `getContinuationToken()` for handling lengthy iterations."],["Developers can utilize `FolderIterator` with `DriveApp`, `File`, or `Folder` objects to access and process folders programmatically."]]],["FolderIterator allows iterating over a large collection of folders. Key actions include using `hasNext()` to check for the next item and `next()` to retrieve it. `getContinuationToken()` provides a token to resume iteration later, helpful for large collections. The example shows how to log every folder's name in a user's Drive, demonstrating iteration through the folder collection. The iterator returns folder objects and can throw an exception if no items remain.\n"]]
