Class Trigger

ماشه

یک ماشه اسکریپت.

روش‌ها

روش نوع بازگشتی شرح مختصر
get Event Type() Event Type نوع رویدادی را که تریگر در آن فعال می‌شود، برمی‌گرداند.
get Handler Function() String تابعی را که هنگام فعال شدن تریگر فراخوانی می‌شود، برمی‌گرداند.
get Trigger Source() Trigger Source منبع رویدادهایی را که باعث فعال شدن trigger می‌شوند، برمی‌گرداند.
get Trigger Source Id() String شناسه (id) مختص به منبع را برمی‌گرداند.
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()

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

برای مثال، یک تریگر onEdit برای صفحه‌گسترده، SPREADSHEETS را برمی‌گرداند، یا یک تریگر مبتنی بر زمان، 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()

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

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

بازگشت

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

مجوز

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

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

get Unique Id()

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

بازگشت

String - شناسه منحصر به فرد تریگر.

مجوز

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

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