Class FileIterator

FileIterator

تکرارکننده ای که به اسکریپت ها اجازه می دهد تا روی مجموعه بزرگی از فایل ها تکرار شوند. می‌توان به تکرارکننده‌های فایل از DriveApp یا یک Folder دسترسی داشت.

// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

مواد و روش ها

روش نوع برگشت توضیح مختصر
getContinuationToken() String رمزی دریافت می کند که می تواند برای از سرگیری این تکرار در زمان دیگری استفاده شود.
hasNext() Boolean تعیین می کند که آیا فراخوانی next() یک آیتم را برمی گرداند یا خیر.
next() File مورد بعدی را در مجموعه فایل ها یا پوشه ها دریافت می کند.

مستندات دقیق

getContinuationToken()

رمزی دریافت می کند که می تواند برای از سرگیری این تکرار در زمان دیگری استفاده شود. این روش در صورتی مفید است که پردازش یک تکرار کننده در یک اجرا از حداکثر زمان اجرا تجاوز کند. توکن‌های ادامه معمولاً برای یک هفته معتبر هستند.

برگشت

String - یک نشانه ادامه که می تواند برای از سرگیری این تکرار با مواردی که در زمان تولید توکن در تکرار کننده باقی مانده اند استفاده شود.


hasNext()

تعیین می کند که آیا فراخوانی next() یک آیتم را برمی گرداند یا خیر.

برگشت

Boolean - true if next() یک آیتم را برمی گرداند. false اگر نه


next()

مورد بعدی را در مجموعه فایل ها یا پوشه ها دریافت می کند. در صورتی که هیچ موردی باقی نماند یک استثنا می اندازد.

برگشت

File - مورد بعدی در مجموعه