Class FolderIterator

تکرارکننده پوشه

شیء‌ای که به اسکریپت‌ها اجازه می‌دهد تا روی مجموعه‌ای بالقوه بزرگ از پوشه‌ها تکرار شوند. تکرارکننده‌های پوشه را می‌توان از طریق Drive App ، یک File یا یک 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());
}

روش‌ها

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

مستندات دقیق

get Continuation Token()

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

بازگشت

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


has Next()

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

بازگشت

Boolean - اگر next() یک آیتم را برگرداند، true و در غیر این صورت false .


next()

آیتم بعدی را در مجموعه فایل‌ها یا پوشه‌ها برمی‌گرداند. اگر هیچ آیتمی باقی نمانده باشد، استثنا ایجاد می‌کند.

بازگشت

Folder - مورد بعدی در مجموعه.