Class FilesResult

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 files as well as a token used to enable pagination in methods that return a limited number of items such as DocsList.getAllFilesForPaging(number, token).

 

 // This example logs the names of all files in the user's drive in batches of 200.
 var pageSize = 200;
 var files = null;
 var token = null; // use a null token for the first lookup
 do {
   var result = DocsList.getAllFilesForPaging(pageSize, token);
   files = result.getFiles();
   token = result.getToken();
   for (var i = 0; i < files.length; i++) {
     Logger.log(files[i].getName());
   }
 } while (files.length >= pageSize);

Deprecated methods

Method	Return type	Brief description
`getFiles()`	`File[]`	Gets the files contained in this result.
`getToken()`	`Token`	Gets the token for this result.

Deprecated methods

`getFiles()`

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

Gets the files contained in this result.

 

 // This example gets the first five files and logs their names.
 var filesResult = DocsList.getAllFilesForPaging(5);
 var files = filesResult.getFiles();
 for (var i in files) {
   Logger.log(files[i].getName());
 }

Return

File[] — the files 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.getAllFilesForPaging(number, token) to get the next set of results.

 

 // This example logs the names of the first 10 files processing 5 at a
 // time.
 var filesResult = DocsList.getAllFilesForPaging(5);
 var files = filesResult.getFiles();
 // log first 5 file names
 for (var i in files) {
   Logger.log(files[i].getName());
 }
 var token = filesResult.getToken();
 var nextResult = DocsList.getAllFilesForPaging(5, token);
 files = nextResult.getFiles();
 // log remaining 5 file names
 for (var i in files) {
   Logger.log(files[i].getName());
 }

Return

Token — the token for this result, useful 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.