Descrizione
Utilizza l'API chrome.alarms per pianificare l'esecuzione periodica del codice o a un'ora specifica in futuro.
Autorizzazioni
alarmsManifest
Per utilizzare l'API chrome.alarms, dichiara l'autorizzazione "alarms" nel manifest:
{
"name": "My extension",
...
"permissions": [
"alarms"
],
...
}
Esempi
Gli esempi seguenti mostrano come utilizzare una sveglia e rispondere. Per provare questa API, installa l'esempio dell'API Sveglia dal repository chrome-extension-samples.
Imposta una sveglia
L'esempio seguente 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
});
});
Rispondi a una sveglia
L'esempio seguente imposta l'icona della barra degli strumenti delle azioni in base al nome della sveglia che è suonata.
service-worker.js:
chrome.alarms.onAlarm.addListener((alarm) => {
chrome.action.setIcon({
path: getIconPath(alarm.name),
});
});
Tipi
Alarm
Proprietà
-
name
stringa
Nome di questa sveglia.
-
periodInMinutes
numero facoltativo
Se non è null, la sveglia è una sveglia ripetuta e suonerà di nuovo dopo
periodInMinutesminuti. -
persistAcrossSessions
booleano
Chrome 150+Indica se la sveglia deve persistere tra le sessioni (riavvii del browser).
-
scheduledTime
numero
Ora in cui è stata pianificata l'attivazione di questa sveglia, in millisecondi dopo l'epoca (ad es.
Date.now() + n). Per motivi di prestazioni, la sveglia potrebbe essere stata ritardata di una quantità arbitraria oltre questo valore.
AlarmCreateInfo
Proprietà
-
delayInMinutes
numero facoltativo
Periodo di tempo in minuti dopo il quale deve essere attivato l'evento
onAlarm. -
name
stringa facoltativa
In attesaNome di questa sveglia.
-
periodInMinutes
numero facoltativo
Se impostato, l'evento onAlarm deve essere attivato ogni
periodInMinutesminuti dopo l'evento iniziale specificato dawhenodelayInMinutes. Se non è impostato, la sveglia suonerà una sola volta. -
persistAcrossSessions
booleano facoltativo
Chrome 150+Indica se la sveglia deve persistere tra le sessioni (riavvii del browser). In Chrome, il valore predefinito è true per corrispondere al comportamento storico, ma devi impostarlo in modo esplicito per massimizzare la compatibilità tra i browser.
-
when
numero facoltativo
Ora in cui deve suonare la sveglia, in millisecondi dopo l'epoca (ad es.
Date.now() + n).
Metodi
clear()
chrome.alarms.clear(
name?: string,
callback?: function,
): Promise<boolean>
Cancella la sveglia con il nome specificato.
Parametri
-
name
stringa facoltativa
Il nome della sveglia da cancellare. Il valore predefinito è la stringa vuota.
-
callback
funzione facoltativa
Il parametro
callbackha il seguente aspetto:(wasCleared: boolean) => void
-
wasCleared
booleano
-
Resi
-
Promise<boolean>
Chrome 91+Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.
clearAll()
chrome.alarms.clearAll(
callback?: function,
): Promise<boolean>
Cancella tutte le sveglie.
Parametri
-
callback
funzione facoltativa
Il parametro
callbackha il seguente aspetto:(wasCleared: boolean) => void
-
wasCleared
booleano
-
Resi
-
Promise<boolean>
Chrome 91+Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.
create()
chrome.alarms.create(
name?: string,
alarmInfo: AlarmCreateInfo,
callback?: function,
): Promise<void>
Crea una sveglia. In prossimità dell'ora o delle ore specificate da alarmInfo, viene attivato l'evento onAlarm. Se esiste un'altra sveglia con lo stesso nome (o senza nome se non ne è stato specificato uno), verrà annullata e sostituita da questa sveglia.
Per ridurre il carico sul computer dell'utente, Chrome limita le sveglie a un massimo di una volta ogni 30 secondi, ma potrebbe ritardarle di una quantità arbitraria in più. Ciò significa che l'impostazione di delayInMinutes o periodInMinutes su un valore inferiore a 0.5 non verrà rispettata e genererà un avviso. when può essere impostato su un valore inferiore a 30 secondi dopo "ora" senza avviso, ma in realtà la sveglia non suonerà per almeno 30 secondi.
Per aiutarti a eseguire il debug dell'app o dell'estensione, quando l'hai caricata non pacchettizzata, non esiste un limite alla frequenza con cui la sveglia può attivarsi.
Parametri
-
name
stringa facoltativa
Nome facoltativo per identificare questa sveglia. Il valore predefinito è la stringa vuota.
-
alarmInfo
Descrive quando deve suonare la sveglia. L'ora iniziale deve essere specificata da
whenodelayInMinutes(ma non da entrambi). SeperiodInMinutesè impostato, la sveglia si ripeterà ogniperiodInMinutesminuti dopo l'evento iniziale. Se non è impostato néwhennédelayInMinutesper una sveglia ripetuta,periodInMinutesviene utilizzato come valore predefinito perdelayInMinutes. -
callback
funzione facoltativa
Chrome 111+Il parametro
callbackha il seguente aspetto:() => void
Resi
-
Promise<void>
Chrome 111+Promessa che viene risolta quando la sveglia è stata creata.
Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.
get()
chrome.alarms.get(
name?: string,
callback?: function,
): Promise<Alarm | undefined>
Recupera i dettagli della sveglia specificata.
Parametri
Resi
-
Promise<Alarm | undefined>
Chrome 91+Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.
getAll()
chrome.alarms.getAll(
callback?: function,
): Promise<Alarm[]>
Recupera un array di tutte le sveglie.
Parametri
Resi
-
Promise<Alarm[]>
Chrome 91+Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.