Class Trigger

ماشه

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

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
getEventType()	EventType	نوع رویدادی را برمی‌گرداند که تریگر در آن فعال می‌شود.
getHandlerFunction()	String	تابعی را برمی‌گرداند که هنگام روشن شدن تریگر فراخوانی می‌شود.
getTriggerSource()	TriggerSource	منبع رویدادهایی را برمی‌گرداند که باعث شلیک ماشه می‌شوند.
getTriggerSourceId()	String	شناسه خاص منبع را برمی‌گرداند.
getUniqueId()	String	یک شناسه منحصربه‌فرد را برمی‌گرداند که می‌توان از آن برای تشخیص محرک‌ها از یکدیگر استفاده کرد.

مستندات دقیق

getEventType()

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

var triggers = ScriptApp.getProjectTriggers();
for (var 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
  }
}

برگشت

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

مجوز

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

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

---

getHandlerFunction()

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

// 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

---

getTriggerSource()

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

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

var triggers = ScriptApp.getProjectTriggers();
for (var 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");
  }
}

برگشت

TriggerSource - ناشر این یک ماشه است

مجوز

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

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

---

getTriggerSourceId()

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

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

برگشت

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

مجوز

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

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

---

getUniqueId()

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

برگشت

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

مجوز

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

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