Class ClockTriggerBuilder

ZegaryAktywatorBuilder

Kreator aktywatorów zegarowych.

Metody

MetodaZwracany typKrótki opis
after(durationMilliseconds)ClockTriggerBuilderOkreśla minimalny czas (w milisekundach) po bieżącym czasie, przez jaki ma działać reguła.
at(date)ClockTriggerBuilderOkreśla, kiedy ma być uruchamiany.
atDate(year, month, day)ClockTriggerBuilderOkreśla, że reguła jest uruchamiany w określonym dniu, domyślnie w pobliżu północy (+/- 15 minut).
atHour(hour)ClockTriggerBuilderOkreśla godzinę, o której ma działać.
create()TriggerTworzy aktywator.
everyDays(n)ClockTriggerBuilderOkreśla, że wyzwalacz ma być uruchamiany co n dni.
everyHours(n)ClockTriggerBuilderOkreśla, że matryca ma być uruchamiana co n godzin.
everyMinutes(n)ClockTriggerBuilderOkreśla, że reguła ma być uruchamiana co n minut.
everyWeeks(n)ClockTriggerBuilderOkreśla, że ma on być uruchamiany co n tygodni.
inTimezone(timezone)ClockTriggerBuilderOkreśla strefę czasową dla określonych dat/godzin, w których ma działać reguła.
nearMinute(minute)ClockTriggerBuilderOkreśla minutę, o której ma być uruchamiany (z dokładnością do 15 minut).
onMonthDay(day)ClockTriggerBuilderOkreśla datę w miesiącu, w którym ma być uruchamiany.
onWeekDay(day)ClockTriggerBuilderOkreśla dzień tygodnia, w którym ma być wykonywany.

Szczegółowa dokumentacja

after(durationMilliseconds)

Określa minimalny czas (w milisekundach) po bieżącym czasie, w którym ma działać reguła. Rzeczywisty czas może się różnić, ale nie będzie krótszy niż określony przez Ciebie minimalny czas.

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

Parametry

NazwaTypOpis
durationMillisecondsIntegerMinimalny czas (w milisekundach) od bieżącego czasu, w którym ma być wykonywany.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


at(date)

Określa, kiedy ma być uruchamiany.

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

Parametry

NazwaTypOpis
dateDateObiekt Date określający, kiedy ma działać reguła.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


atDate(year, month, day)

Określa, że reguła jest uruchamiany w określonym dniu, domyślnie w pobliżu północy (+/- 15 minut).

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

Parametry

NazwaTypOpis
yearIntegerRok kalendarzowy, w którym ma być zaplanowany reguła.
monthIntegerMiesiąc kalendarzowy, w którym ma być zaplanowany reguła (powinna to być liczba z zakresu 1–12).
dayIntegerDzień kalendarzowy, w którym ma być zaplanowany reguła (powinna to być liczba z zakresu od 1 do 31).

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


atHour(hour)

Określa godzinę, o której ma działać.

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

NazwaTypOpis
hourIntegerGodzina, o której ma się uruchomić.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


create()

Tworzy aktywator.

Powrót

Trigger – nowo utworzony zaplanowany reguła.


everyDays(n)

Określa, że wyzwalacz ma być uruchamiany co n dni.

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

Parametry

NazwaTypOpis
nIntegerLiczba dni między wykonaniem.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


everyHours(n)

Określa, że matryca ma być uruchamiana co n godzin.

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

Parametry

NazwaTypOpis
nIntegerLiczba godzin między wykonaniami.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


everyMinutes(n)

Określa, że reguła ma być uruchamiana co n minut. Wartość w polu n musi być równa 1, 5, 10, 15 lub 30.

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

Parametry

NazwaTypOpis
nIntegerLiczba minut między wykonaniami.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


everyWeeks(n)

Określa, że wyzwalacz ma być uruchamiany co n tygodni.

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

Parametry

NazwaTypOpis
nIntegerLiczba tygodni między wykonaniem.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


inTimezone(timezone)

Określa strefę czasową dla określonych dat/godzin, w których ma działać reguła. Domyślnie strefa czasowa to ta, w której znajduje się skrypt.

Lista prawidłowych ciągów tekstowych stref czasowych odpowiada prawidłowym ciągom tekstowym stref czasowych wymienionym na stronie Joda.org. Nieprawidłowy ciąg znaków 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

NazwaTypOpis
timezoneStringStrefa czasowa, w której mają być interpretowane informacje o czasie w zdarzeniu.

Powrót

ClockTriggerBuilder – ta ClockTriggerBuilder służy do tworzenia łańcuszków.


nearMinute(minute)

Określa minutę, o której ma być uruchamiany (z dokładnością do 15 minut). Jeśli funkcja nearMinute() nie zostanie wywołana, zostanie użyta losowa wartość minut.

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

NazwaTypOpis
minuteIntegerMinuta, w której ma nastąpić działanie.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


onMonthDay(day)

Określa datę w miesiącu, w którym ma być uruchamiany.

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

Parametry

NazwaTypOpis
dayIntegerDzień miesiąca, w którym ma być zaplanowana reguła.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.


onWeekDay(day)

Określa dzień tygodnia, w którym ma być wykonywany.

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

Parametry

NazwaTypOpis
dayWeekdayDzień tygodnia, w którym ma być wykonywane.

Powrót

ClockTriggerBuilder – kreator do łańcuchowania.