Kreator reguł zegara.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
after(durationMilliseconds) | ClockTriggerBuilder | Określa minimalny czas trwania (w milisekundach) po bieżącym czasie działania reguły. |
at(date) | ClockTriggerBuilder | Określa, kiedy reguła się uruchamia. |
atDate(year, month, day) | ClockTriggerBuilder | Określa, że reguła jest uruchamiana w określonym dniu, domyślnie o północy (+/- 15 minut). |
atHour(hour) | ClockTriggerBuilder | Określa godzinę uruchamiania reguły. |
create() | Trigger | Tworzy regułę. |
everyDays(n) | ClockTriggerBuilder | Określa uruchamianie reguły co n dni. |
everyHours(n) | ClockTriggerBuilder | Określa uruchamianie reguły co n godzin. |
everyMinutes(n) | ClockTriggerBuilder | Określa uruchamianie reguły co n minuty. |
everyWeeks(n) | ClockTriggerBuilder | Określa uruchamianie reguły co n tygodni. |
inTimezone(timezone) | ClockTriggerBuilder | Określa strefę czasową dla określonych dat i godzin, w których reguła ma się uruchamiać. |
nearMinute(minute) | ClockTriggerBuilder | Określa minutę, w której reguła ma się uruchomić (plus lub minus 15 minut). |
onMonthDay(day) | ClockTriggerBuilder | Określa datę uruchomienia reguły. |
onWeekDay(day) | ClockTriggerBuilder | Określa dzień tygodnia uruchamiania reguły. |
Szczegółowa dokumentacja
after(durationMilliseconds)
Określa minimalny czas trwania (w milisekundach) po bieżącym czasie działania reguły. Rzeczywista długość może być inna, ale nie będzie mniejsza niż wartość minimalna.
// Creates a trigger that runs 10 minutes later ScriptApp.newTrigger("myFunction") .timeBased() .after(10 * 60 * 1000) .create();
Parametry
Nazwa | Typ | Opis |
---|---|---|
durationMilliseconds | Integer | Minimalny czas trwania (w milisekundach) po bieżącej porze uruchomienia reguły. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
at(date)
Określa, kiedy reguła się uruchamia.
// Creates a trigger for December 1, 2012 var triggerDay = new Date(2012, 11, 1); ScriptApp.newTrigger("myFunction") .timeBased() .at(triggerDay) .create();
Parametry
Nazwa | Typ | Opis |
---|---|---|
date | Date | Obiekt typu data określający, kiedy reguła ma się uruchomić. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
atDate(year, month, day)
Określa, że reguła jest uruchamiana w określonym dniu, domyślnie o północy (+/- 15 minut).
// Schedules for January 1st, 2013 ScriptApp.newTrigger("myFunction") .timeBased() .atDate(2013, 1, 1) .create();
Parametry
Nazwa | Typ | Opis |
---|---|---|
year | Integer | Rok kalendarzowy, w którym zaplanujesz uruchomienie reguły. |
month | Integer | Miesiąc kalendarzowy, aby zaplanować regułę (musi być liczbą od 1 do 12 włącznie). |
day | Integer | Dzień kalendarza, w którym zostanie zaplanowany aktywator (powinien być to liczba z zakresu od 1 do 31 włącznie). |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
atHour(hour)
Określa godzinę uruchamiania reguły.
// 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();
Parametry
Nazwa | Typ | Opis |
---|---|---|
hour | Integer | Godzina uruchomienia. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
create()
everyDays(n)
Określa uruchamianie reguły co n
dni.
ScriptApp.newTrigger("myFunction") .timeBased() .everyDays(3) .create();
Parametry
Nazwa | Typ | Opis |
---|---|---|
n | Integer | Liczba dni między wykonaniami. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
everyHours(n)
Określa uruchamianie reguły co n
godzin.
ScriptApp.newTrigger("myFunction") .timeBased() .everyHours(12) .create();
Parametry
Nazwa | Typ | Opis |
---|---|---|
n | Integer | Liczba godzin między wykonaniem. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
everyMinutes(n)
Określa uruchamianie reguły co n
minuty. n
może wynosić 1, 5, 10, 15 lub 30.
ScriptApp.newTrigger("myFunction") .timeBased() .everyMinutes(10) .create();
Parametry
Nazwa | Typ | Opis |
---|---|---|
n | Integer | Liczba minut między wykonaniem. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
everyWeeks(n)
Określa uruchamianie reguły co n
tygodni.
ScriptApp.newTrigger("myFunction") .timeBased() .everyWeeks(2) .create();
Parametry
Nazwa | Typ | Opis |
---|---|---|
n | Integer | Liczba tygodni między wykonaniami. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
inTimezone(timezone)
Określa strefę czasową dla określonych dat i godzin, w których reguła ma się uruchamiać. Domyślnie strefa czasowa jest ustawiona na skrypcie.
Lista prawidłowych ciągów czasowych odpowiada prawidłowym ciągom strefy czasowej wskazanym na stronie Joda.org. Nieprawidłowy ciąg tekstowy strefy czasowej powoduje błąd skryptu.
// 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();
Parametry
Nazwa | Typ | Opis |
---|---|---|
timezone | String | Strefa czasowa, w której mają być przetwarzane informacje o czasie w zdarzeniu. |
Zwróć
ClockTriggerBuilder
– ClockTriggerBuilder
do łańcucha.
nearMinute(minute)
Określa minutę, w której reguła ma się uruchomić (plus lub minus 15 minut). Jeśli nie zostanie wywołany element nearMinute()
, zostanie użyta losowa wartość minuta.
// 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();
Parametry
Nazwa | Typ | Opis |
---|---|---|
minute | Integer | Minuta, którą należy odpalić. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
onMonthDay(day)
Określa datę uruchomienia reguły.
// Schedules for the first of every month ScriptApp.newTrigger("myFunction") .timeBased() .onMonthDay(1) .create();
Parametry
Nazwa | Typ | Opis |
---|---|---|
day | Integer | Dzień miesiąca, w którym ma być zaplanowana reguła. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.
onWeekDay(day)
Określa dzień tygodnia uruchamiania reguły.
ScriptApp.newTrigger("myFunction") .timeBased() .onWeekDay(ScriptApp.WeekDay.FRIDAY) .create();
Parametry
Nazwa | Typ | Opis |
---|---|---|
day | Weekday | Dzień tygodnia, w którym uruchamiane są reguły. |
Zwróć
ClockTriggerBuilder
– Kreator łańcuchów.