Class ClockTriggerBuilder

ClockTriggerBuilder

Ein Builder für Uhr-Trigger.

Methoden

MethodeRückgabetypKurzbeschreibung
after(durationMilliseconds)ClockTriggerBuilderGibt die Mindestdauer (in Millisekunden) nach dem aktuellen Zeitpunkt an, zu dem der Trigger ausgeführt wird.
at(date)ClockTriggerBuilderGibt an, wann der Trigger ausgeführt wird.
atDate(year, month, day)ClockTriggerBuilderGibt an, dass der Trigger am angegebenen Datum ausgelöst wird, standardmäßig gegen Mitternacht (+/- 15 Minuten).
atHour(hour)ClockTriggerBuilderGibt die Stunde an, zu der der Trigger ausgeführt wird.
create()TriggerErstellt den Trigger.
everyDays(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Tage ausgeführt werden soll.
everyHours(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Stunden ausgeführt wird.
everyMinutes(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Minuten ausgeführt wird.
everyWeeks(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Wochen ausgeführt wird.
inTimezone(timezone)ClockTriggerBuilderGibt die Zeitzone für das angegebene Datum und die angegebene Uhrzeit an, wenn der Trigger ausgeführt wird.
nearMinute(minute)ClockTriggerBuilderGibt die Minute an, in der der Trigger ausgeführt wird (plus oder minus 15 Minuten).
onMonthDay(day)ClockTriggerBuilderGibt das Datum im Monat an, an dem der Trigger ausgeführt wird.
onWeekDay(day)ClockTriggerBuilderGibt den Wochentag an, an dem der Trigger ausgeführt wird.

Detaillierte Dokumentation

after(durationMilliseconds)

Gibt die Mindestdauer (in Millisekunden) nach dem aktuellen Zeitpunkt an, zu dem der Trigger ausgeführt wird. Die tatsächliche Dauer kann variieren, liegt jedoch nicht unter der von Ihnen angegebenen Mindestdauer.

// Creates a trigger that runs 10 minutes later
ScriptApp.newTrigger("myFunction")
  .timeBased()
  .after(10 * 60 * 1000)
  .create();

Parameter

NameTypBeschreibung
durationMillisecondsIntegerDie Mindestdauer (in Millisekunden) nach der aktuellen Zeit, wenn ausgeführt werden soll.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


at(date)

Gibt an, wann der Trigger ausgeführt wird.

// Creates a trigger for December 1, 2012
var triggerDay = new Date(2012, 11, 1);
ScriptApp.newTrigger("myFunction")
  .timeBased()
  .at(triggerDay)
  .create();

Parameter

NameTypBeschreibung
dateDateEin Datumsobjekt, das angibt, wann der Trigger ausgeführt werden soll.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


atDate(year, month, day)

Gibt an, dass der Trigger am angegebenen Datum ausgelöst wird, standardmäßig gegen Mitternacht (+/- 15 Minuten).

// Schedules for January 1st, 2013
ScriptApp.newTrigger("myFunction")
  .timeBased()
  .atDate(2013, 1, 1)
  .create();

Parameter

NameTypBeschreibung
yearIntegerDas Kalenderjahr, in dem der Trigger geplant werden soll.
monthIntegerDer Kalendermonat für den Zeitplan des Triggers. Er sollte eine Zahl zwischen 1 und 12 sein. einschließlich).
dayIntegerDer Kalendertag, an dem der Trigger geplant werden soll (muss eine Zahl zwischen 1 und 31 sein, einschließlich).

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


atHour(hour)

Gibt die Stunde an, zu der der Trigger ausgeführt wird.

// Runs between 5am-6am in the timezone of the script
ScriptApp.newTrigger("myFunction")
  .timeBased()
  .atHour(5)
  .everyDays(1) // Frequency is required if you are using atHour() or nearMinute()
  .create();

Parameter

NameTypBeschreibung
hourIntegerDie Stunde, zu der das Ereignis ausgelöst werden soll.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


create()

Erstellt den Trigger.

Rückflug

Trigger: Der neu erstellte, geplante Trigger.


everyDays(n)

Gibt an, dass der Trigger alle n Tage ausgeführt werden soll.

ScriptApp.newTrigger("myFunction")
  .timeBased()
  .everyDays(3)
  .create();

Parameter

NameTypBeschreibung
nIntegerDie Anzahl der Tage zwischen Ausführungen.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


everyHours(n)

Gibt an, dass der Trigger alle n Stunden ausgeführt wird.

ScriptApp.newTrigger("myFunction")
  .timeBased()
  .everyHours(12)
  .create();

Parameter

NameTypBeschreibung
nIntegerDie Anzahl der Stunden zwischen Ausführungen.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


everyMinutes(n)

Gibt an, dass der Trigger alle n Minuten ausgeführt wird. n muss 1, 5, 10, 15 oder 30 sein.

ScriptApp.newTrigger("myFunction")
  .timeBased()
  .everyMinutes(10)
  .create();

Parameter

NameTypBeschreibung
nIntegerDie Anzahl der Minuten zwischen Ausführungen.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


everyWeeks(n)

Gibt an, dass der Trigger alle n Wochen ausgeführt wird.

ScriptApp.newTrigger("myFunction")
  .timeBased()
  .everyWeeks(2)
  .onWeekDay(ScriptApp.WeekDay.FRIDAY)
  .create();

Parameter

NameTypBeschreibung
nIntegerDie Anzahl der Wochen zwischen Ausführungen.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


inTimezone(timezone)

Gibt die Zeitzone für das angegebene Datum und die angegebene Uhrzeit an, wenn der Trigger ausgeführt wird. Standardmäßig enthält der Parameter ist die Zeitzone des Skripts.

Die Liste der gültigen Zeitzonenstrings entspricht den gültigen Zeitzonenstrings, die bei Joda.org aufgeführt sind. Ungültiger Zeitzonenstring führt das Skript zu einem Fehler.

// Schedule the trigger to execute at noon every day in the US/Pacific time zone
ScriptApp.newTrigger("myFunction")
  .timeBased()
  .atHour(12)
  .everyDays(1)
  .inTimezone("America/Los_Angeles")
  .create();

Parameter

NameTypBeschreibung
timezoneStringDie Zeitzone, mit der Zeitinformationen im Ereignis behandelt werden.

Rückflug

ClockTriggerBuilder: Diese ClockTriggerBuilder zum Verketten.


nearMinute(minute)

Gibt die Minute an, in der der Trigger ausgeführt wird (plus oder minus 15 Minuten). Wenn nearMinute() nicht aufgerufen wird, wird ein zufälliger Minutenwert verwendet.

// Runs at approximately 5:30am in the timezone of the script
ScriptApp.newTrigger("myFunction")
  .timeBased()
  .atHour(5)
  .nearMinute(30)
  .everyDays(1) // Frequency is required if you are using atHour() or nearMinute()
  .create();

Parameter

NameTypBeschreibung
minuteIntegerDie Minute, zu der gefeuert werden soll.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


onMonthDay(day)

Gibt das Datum im Monat an, an dem der Trigger ausgeführt wird.

// Schedules for the first of every month
ScriptApp.newTrigger("myFunction")
  .timeBased()
  .onMonthDay(1)
  .create();

Parameter

NameTypBeschreibung
dayIntegerDer Tag des Monats, für den der Trigger geplant werden soll.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.


onWeekDay(day)

Gibt den Wochentag an, an dem der Trigger ausgeführt wird.

ScriptApp.newTrigger("myFunction")
  .timeBased()
  .onWeekDay(ScriptApp.WeekDay.FRIDAY)
  .create();

Parameter

NameTypBeschreibung
dayWeekdayDer Wochentag, an dem die Benachrichtigung ausgelöst werden soll.

Rückflug

ClockTriggerBuilder: Der Builder für die Verkettung.