Class Trigger

العامل المشغِّل

مشغِّل نص برمجي

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
getEventType()EventTypeتعرِض هذه السمة نوع الحدث الذي يتم تشغيل العامل المشغِّل عند حدوثه.
getHandlerFunction()Stringتُرجِع الدالة التي سيتمّ استدعاؤها عند بدء الإجراء المشغِّل.
getTriggerSource()TriggerSourceتعرِض هذه الدالة مصدر الأحداث التي ستؤدي إلى تنشيط العامل المشغِّل.
getTriggerSourceId()Stringلعرض رقم التعريف الخاص بالمصدر.
getUniqueId()Stringتعرِض هذه السمة معرّفًا فريدًا يمكن استخدامه للتمييز بين عوامل التشغيل.

مستندات تفصيلية

getEventType()

تعرِض هذه السمة نوع الحدث الذي يتم تشغيل العامل المشغِّل عند حدوثه.

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

الإرجاع

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 لجدول البيانات 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`);
  }
}

الإرجاع

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