Class Trigger

ماشه

یک محرک اسکریپت.

روش ها

روش نوع برگشت شرح مختصر
get Event Type() Event Type نوع رویدادی را برمی‌گرداند که تریگر در آن فعال می‌شود.
get Handler Function() String تابعی را برمی‌گرداند که هنگام روشن شدن تریگر فراخوانی می‌شود.
get Trigger Source() Trigger Source منبع رویدادهایی را برمی‌گرداند که باعث شلیک ماشه می‌شوند.
get Trigger Source Id() String شناسه اختصاصی منبع را برمی‌گرداند.
get Unique Id() String یک شناسه منحصربه‌فرد را برمی‌گرداند که می‌توان از آن برای تشخیص محرک‌ها از یکدیگر استفاده کرد.

مستندات دقیق

get Event Type()

نوع رویدادی را برمی‌گرداند که تریگر در آن فعال می‌شود.

const triggers = ScriptApp.getProjectTriggers();
for (let i = 0; i < triggers.length; i++) {
  if (triggers[i].getEventType() === ScriptApp.EventType.CLOCK) {
    // Some code here - other options are:
    // ScriptApp.EventType.ON_EDIT
    // ScriptApp.EventType.ON_FORM_SUBMIT
    // ScriptApp.EventType.ON_OPEN
  }
}

بازگشت

Event Type - نوع رویدادی که این یک ماشه برای آن است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/script.scriptapp

get Handler Function()

تابعی را برمی‌گرداند که هنگام روشن شدن تریگر فراخوانی می‌شود.

// Create a trigger for the script.
ScriptApp.newTrigger('myFunction')
    .forSpreadsheet('id of my spreadsheet')
    .onEdit()
    .create();
Logger.log(ScriptApp.getProjectTriggers()[0]
               .getHandlerFunction());  // logs "myFunction"

بازگشت

String - نام روش

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/script.scriptapp

get Trigger Source()

منبع رویدادهایی را برمی‌گرداند که باعث شلیک ماشه می‌شوند.

به عنوان مثال، یک راه‌انداز صفحه‌گسترده onEdit، SPREADSHETS را برمی‌گرداند، یا یک محرک مبتنی بر زمان، CLOCK را برمی‌گرداند.

const triggers = ScriptApp.getProjectTriggers();
for (let i = 0; i < triggers.length; i++) {
  if (triggers[i].getTriggerSource() === ScriptApp.TriggerSource.CLOCK) {
    Logger.log(`${triggers[i].getUniqueId()} source is clock`);
  } else if (
      triggers[i].getTriggerSource() === ScriptApp.TriggerSource.SPREADSHEETS) {
    Logger.log(`${triggers[i].getUniqueId()} source is spreadsheets`);
  }
}

بازگشت

Trigger Source - ناشر این یک ماشه است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/script.scriptapp

get Trigger Source Id()

شناسه اختصاصی منبع را برمی‌گرداند.

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

بازگشت

String - شناسه موجودی در ناشر که این یک ماشه برای آن است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/script.scriptapp

get Unique Id()

یک شناسه منحصربه‌فرد را برمی‌گرداند که می‌توان از آن برای تشخیص محرک‌ها از یکدیگر استفاده کرد.

بازگشت

String - شناسه منحصر به فرد ماشه

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/script.scriptapp