chrome.alarms

Deskripsi

Gunakan API chrome.alarms untuk menjadwalkan kode agar berjalan secara berkala atau pada waktu tertentu di masa mendatang.

Izin

alarms

Manifes

Untuk menggunakan chrome.alarms API, deklarasikan izin "alarms" dalam manifes:

{
  "name": "My extension",
  ...
  "permissions": [
    "alarms"
  ],
  ...
}

Contoh

Contoh berikut menunjukkan cara menggunakan dan merespons alarm. Untuk mencoba API ini, instal contoh Alarm API dari repositori chrome-extension-samples.

Setel alarm

Contoh berikut menyetel alarm di service worker saat ekstensi diinstal:

service-worker.js:

chrome.runtime.onInstalled.addListener(async ({ reason }) => {
  if (reason !== 'install') {
    return;
  }

  // Create an alarm so we have something to look at in the demo
  await chrome.alarms.create('demo-default-alarm', {
    delayInMinutes: 1,
    periodInMinutes: 1
  });
});

Merespons alarm

Contoh berikut menetapkan ikon toolbar tindakan berdasarkan nama alarm yang berbunyi.

service-worker.js:

chrome.alarms.onAlarm.addListener((alarm) => {
  chrome.action.setIcon({
    path: getIconPath(alarm.name),
  });
});

Jenis

Alarm

Properti

  • nama

    string

    Nama alarm ini.

  • periodInMinutes

    nomor opsional

    Jika tidak bernilai null, alarm adalah alarm berulang dan akan berbunyi lagi dalam periodInMinutes menit.

  • scheduledTime

    angka

    Waktu saat alarm ini dijadwalkan untuk diaktifkan, dalam milidetik setelah epoch (mis. Date.now() + n). Untuk alasan performa, alarm mungkin telah ditunda dalam jumlah yang tidak ditentukan di luar waktu ini.

AlarmCreateInfo

Properti

  • delayInMinutes

    nomor opsional

    Durasi waktu dalam menit setelah peristiwa onAlarm harus dipicu.

  • periodInMinutes

    nomor opsional

    Jika disetel, peristiwa onAlarm akan dipicu setiap periodInMinutes menit setelah peristiwa awal yang ditentukan oleh when atau delayInMinutes. Jika tidak disetel, alarm hanya akan berbunyi satu kali.

  • kapan

    nomor opsional

    Waktu saat alarm harus berbunyi, dalam milidetik setelah epoch (misalnya, Date.now() + n).

Metode

clear()

Janji 
chrome.alarms.clear(
  name?: string,
  callback?: function,
): Promise<boolean>

Menghapus alarm dengan nama yang diberikan.

Parameter

  • nama

    string opsional

    Nama alarm yang akan dihapus. Default-nya adalah string kosong.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (wasCleared: boolean) => void

    • wasCleared

      boolean

Hasil

  • Promise<boolean>

    Chrome 91+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

clearAll()

Janji 
chrome.alarms.clearAll(
  callback?: function,
): Promise<boolean>

Menghapus semua alarm.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (wasCleared: boolean) => void

    • wasCleared

      boolean

Hasil

  • Promise<boolean>

    Chrome 91+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

create()

Janji 
chrome.alarms.create(
  name?: string,
  alarmInfo: AlarmCreateInfo,
  callback?: function,
): Promise<void>

Membuat alarm. Mendekati waktu yang ditentukan oleh alarmInfo, peristiwa onAlarm diaktifkan. Jika ada alarm lain dengan nama yang sama (atau tanpa nama jika tidak ada yang ditentukan), alarm tersebut akan dibatalkan dan digantikan oleh alarm ini.

Untuk mengurangi beban pada mesin pengguna, Chrome membatasi alarm maksimal sekali setiap 30 detik, tetapi dapat menundanya dalam jumlah yang lebih besar. Artinya, menetapkan delayInMinutes atau periodInMinutes ke nilai yang lebih kecil dari 0.5 tidak akan dipatuhi dan akan menyebabkan peringatan. when dapat disetel ke kurang dari 30 detik setelah "sekarang" tanpa peringatan, tetapi sebenarnya tidak akan menyebabkan alarm berbunyi setidaknya selama 30 detik.

Untuk membantu Anda men-debug aplikasi atau ekstensi, saat Anda memuatnya tanpa di-unzip, tidak ada batasan seberapa sering alarm dapat diaktifkan.

Parameter

  • nama

    string opsional

    Nama opsional untuk mengidentifikasi alarm ini. Default-nya adalah string kosong.

  • alarmInfo

    AlarmCreateInfo

    Menjelaskan kapan alarm harus berbunyi. Waktu awal harus ditentukan oleh when atau delayInMinutes (tetapi tidak keduanya). Jika periodInMinutes disetel, alarm akan berulang setiap periodInMinutes menit setelah peristiwa awal. Jika when atau delayInMinutes tidak disetel untuk alarm berulang, periodInMinutes akan digunakan sebagai default untuk delayInMinutes.

  • callback

    fungsi opsional

    Chrome 111+

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 111+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

get()

Janji 
chrome.alarms.get(
  name?: string,
  callback?: function,
): Promise<Alarm | undefined>

Mengambil detail tentang alarm yang ditentukan.

Parameter

  • nama

    string opsional

    Nama alarm yang akan didapatkan. Default-nya adalah string kosong.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (alarm?: Alarm) => void

Hasil

  • Promise<Alarm | undefined>

    Chrome 91+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getAll()

Janji 
chrome.alarms.getAll(
  callback?: function,
): Promise<Alarm[]>

Mendapatkan array semua alarm.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (alarms: Alarm[]) => void

Hasil

  • Promise<Alarm[]>

    Chrome 91+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

Acara

onAlarm

chrome.alarms.onAlarm.addListener(
  callback: function,
)

Diaktifkan saat alarm telah berlalu. Berguna untuk halaman acara.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (alarm: Alarm) => void