Ein Builder für Uhrauslöser.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
after(durationMilliseconds) | ClockTriggerBuilder | Gibt die Mindestdauer (in Millisekunden) nach der aktuellen Zeit an, zu der der Trigger ausgeführt wird. |
at(date) | ClockTriggerBuilder | Gibt an, wann der Trigger ausgeführt wird. |
atDate(year, month, day) | ClockTriggerBuilder | Gibt an, dass der Trigger am angegebenen Datum ausgelöst wird, standardmäßig gegen Mitternacht (+/- 15 Minuten). |
atHour(hour) | ClockTriggerBuilder | Gibt die Stunde an, zu der der Trigger ausgeführt wird. |
create() | Trigger | Erstellt den Trigger. |
everyDays(n) | ClockTriggerBuilder | Gibt an, dass der Trigger alle n Tage ausgeführt werden soll. |
everyHours(n) | ClockTriggerBuilder | Gibt an, dass der Trigger alle n Stunden ausgeführt werden soll. |
everyMinutes(n) | ClockTriggerBuilder | Gibt an, dass der Trigger alle n Minuten ausgeführt wird. |
everyWeeks(n) | ClockTriggerBuilder | Gibt an, dass der Trigger alle n Wochen ausgeführt werden soll. |
inTimezone(timezone) | ClockTriggerBuilder | Gibt die Zeitzone für das angegebene Datum und die angegebene Uhrzeit an, wenn der Trigger ausgeführt wird. |
nearMinute(minute) | ClockTriggerBuilder | Gibt die Minute an, in der der Trigger ausgeführt wird (plus oder minus 15 Minuten). |
onMonthDay(day) | ClockTriggerBuilder | Gibt das Datum im Monat an, an dem der Trigger ausgeführt wird. |
onWeekDay(day) | ClockTriggerBuilder | Gibt den Wochentag an, an dem der Trigger ausgeführt wird. |
Detaillierte Dokumentation
after(durationMilliseconds)
Gibt die Mindestdauer (in Millisekunden) nach der aktuellen Zeit an, zu der der Trigger ausgeführt wird. Die tatsächliche Dauer kann abweichen, ist aber nicht unter dem von Ihnen angegebenen Minimum.
// Creates a trigger that runs 10 minutes later ScriptApp.newTrigger("myFunction") .timeBased() .after(10 * 60 * 1000) .create();
Parameter
Name | Typ | Beschreibung |
---|---|---|
durationMilliseconds | Integer | Die Mindestdauer (in Millisekunden) nach der aktuellen Zeit, zu der der Trigger ausgeführt werden soll. |
Return
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
Name | Typ | Beschreibung |
---|---|---|
date | Date | Ein Datumsobjekt, das angibt, wann der Trigger ausgeführt werden soll. |
Return
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
Name | Typ | Beschreibung |
---|---|---|
year | Integer | Das Kalenderjahr, in dem der Trigger geplant werden soll. |
month | Integer | Der Kalendermonat für die Planung des Triggers (muss eine Zahl zwischen 1 und 12 sein). |
day | Integer | Der Kalendertag, an dem der Trigger geplant werden soll. Er muss eine Zahl zwischen 1 und 31 sein. |
Return
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
Name | Typ | Beschreibung |
---|---|---|
hour | Integer | Die Stunde, zu der die Auslösung erfolgt. |
Return
ClockTriggerBuilder
: Der Builder für die Verkettung.
create()
everyDays(n)
Gibt an, dass der Trigger alle n
Tage ausgeführt werden soll.
ScriptApp.newTrigger("myFunction") .timeBased() .everyDays(3) .create();
Parameter
Name | Typ | Beschreibung |
---|---|---|
n | Integer | Die Anzahl der Tage zwischen Ausführungen. |
Return
ClockTriggerBuilder
: Der Builder für die Verkettung.
everyHours(n)
Gibt an, dass der Trigger alle n
Stunden ausgeführt werden soll.
ScriptApp.newTrigger("myFunction") .timeBased() .everyHours(12) .create();
Parameter
Name | Typ | Beschreibung |
---|---|---|
n | Integer | Die Anzahl der Stunden zwischen Ausführungen. |
Return
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
Name | Typ | Beschreibung |
---|---|---|
n | Integer | Die Anzahl der Minuten zwischen Ausführungen. |
Return
ClockTriggerBuilder
: Der Builder für die Verkettung.
everyWeeks(n)
Gibt an, dass der Trigger alle n
Wochen ausgeführt werden soll.
ScriptApp.newTrigger("myFunction") .timeBased() .everyWeeks(2) .onWeekDay(ScriptApp.WeekDay.FRIDAY) .create();
Parameter
Name | Typ | Beschreibung |
---|---|---|
n | Integer | Die Anzahl der Wochen zwischen den Ausführungen. |
Return
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 entspricht die Zeitzone der Zeitzone des Skripts.
Die Liste gültiger Zeitzonenstrings entspricht den gültigen Zeitzonenstrings, die von Joda.org aufgelistet werden. Ein ungültiger Zeitzonenstring führt dazu, dass das Skript einen Fehler ausgibt.
// 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
Name | Typ | Beschreibung |
---|---|---|
timezone | String | Die Zeitzone, mit der Zeitinformationen im Ereignis verarbeitet werden sollen. |
Return
ClockTriggerBuilder
: Dieses ClockTriggerBuilder
für Verkettungen.
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
Name | Typ | Beschreibung |
---|---|---|
minute | Integer | Die Minute, in der gefeuert wird. |
Return
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
Name | Typ | Beschreibung |
---|---|---|
day | Integer | Der Tag des Monats, für den der Trigger geplant werden soll. |
Return
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
Name | Typ | Beschreibung |
---|---|---|
day | Weekday | Der Wochentag, an dem die Auslösung erfolgt. |
Return
ClockTriggerBuilder
: Der Builder für die Verkettung.