chrome.alarms

Descrizione

Autorizzazioni

Per utilizzare l'API chrome.alarms, dichiara l'autorizzazione "alarms" nel manifest:

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

Concetti e utilizzo

Per garantire un comportamento affidabile, è utile comprendere il funzionamento dell'API.

Sospensione del dispositivo

Le sveglie continuano a funzionare mentre un dispositivo è in modalità sospensione. Tuttavia, una sveglia non riattiva un dispositivo. Quando il dispositivo si riattiva, le sveglie perse vengono attivate. Le sveglie ripetute si attiveranno al massimo una volta e verranno riprogrammate utilizzando il periodo specificato a partire dal momento in cui il dispositivo si riattiva, senza tenere conto del tempo trascorso dall'impostazione originale della sveglia.

Persistenza

In genere, gli allarmi rimangono attivi fino all'aggiornamento di un'estensione. Tuttavia, questa operazione non è garantita e gli avvisi potrebbero essere cancellati al riavvio del browser. Di conseguenza, valuta la possibilità di impostare un valore nello spazio di archiviazione quando viene creato un allarme e poi assicurati che esista ogni volta che viene avviato il service worker. Ad esempio:

const STORAGE_KEY = "user-preference-alarm-enabled";  async function checkAlarmState() {   const { alarmEnabled } = await chrome.storage.get(STORAGE_KEY);    if (alarmEnabled) {     const alarm = await chrome.alarms.get("my-alarm");      if (!alarm) {       await chrome.alarms.create({ periodInMinutes: 1 });     }   } }  checkAlarmState(); 

Esempi

Gli esempi seguenti mostrano come utilizzare e rispondere a un allarme. Per provare questa API, installa l'esempio di API Alarm dal repository chrome-extension-samples.

Imposta una sveglia

Il seguente esempio imposta una sveglia nel service worker quando l'estensione viene installata:

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   }); }); 

Rispondere a un allarme

L'esempio seguente imposta l'icona della barra degli strumenti delle azioni in base al nome dell'allarme attivato.

service-worker.js:

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

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

chrome.alarms.clearAll(): Promise<boolean>

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

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

chrome.alarms.getAll(): Promise<Alarm[]>

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