Class FoldersResult

Deprecated. The DocsList service was deprecated on December 11, 2014. To work with files in Google Drive, use the Drive service instead.

Holds an array of folders as well as a token used to enable pagination in methods that return a limited number of items such as DocsList.getAllFoldersForPaging(number, token).

 

 // This example logs the names of all folders in the users drive in batches of 5
 var pageSize = 5;
 var folders = null;
 var token = null; // using null token for the first lookup
 do {
   var result = DocsList.getAllFoldersForPaging(pageSize, token);
   folders = result.getFolders();
   token = result.getToken();
   for (var i = 0; i < folders.length; i++) {
     Logger.log(folders[i].getName());
   }
 } while (folders.length >= pageSize);

Deprecated methods

Method	Return type	Brief description
`getFolders()`	`Folder[]`	Gets the folders contained in this result.
`getToken()`	`Token`	Gets the token for this result.

Deprecated methods

`getFolders()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the folders contained in this result.

 

 // This example gets the first 3 folders and logs their names.
 var foldersResult = DocsList.getAllFoldersForPaging(3);
 var folders = foldersResult.getFolders();
 for (var i in folders) {
   Logger.log(folders[i].getName());
 }

Return

Folder[] — the folders in this result

`getToken()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the token for this result. A token is used for pagination purposes. It can be passed into functions like DocsList.getAllFoldersForPaging(number, token) to get the next set of results.

 

 // This example logs the names of the first 6 folders processing 3 at a
 // time.
 var foldersResult = DocsList.getAllFoldersForPaging(3);
 var folders = foldersResult.getFolders();
 for (var i in folders) {
   Logger.log(folders[i].getName());
 }
 var token = foldersResult.getToken();
 var nextResult = DocsList.getAllFoldersForPaging(3, token);
 folders = nextResult.getFolders();
 for (var i in folders) {
   Logger.log(folders[i].getName());
 }

Return

Token — the token for this result, used for pagination purposes

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated February 26, 2015.