Class FileIterator

تکرار کننده فایل

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

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

روش ها

روش نوع برگشت شرح مختصر
get Continuation Token() String رمزی دریافت می کند که می تواند برای از سرگیری این تکرار در زمان دیگری استفاده شود.
has Next() Boolean تعیین می کند که آیا فراخوانی next() یک آیتم را برمی گرداند یا خیر.
next() File مورد بعدی را در مجموعه فایل ها یا پوشه ها دریافت می کند.

مستندات دقیق

get Continuation Token()

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

بازگشت

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

has Next()

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

بازگشت

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

next()

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

بازگشت

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