window.navigator.requestWakeLock

Non standard
Cette fonctionnalité n'est pas en voie de standardisation au W3C, mais elle est supportée par la plateforme Firefox OS. Bien que son implémentation puisse changer dans le futur et qu'elle n'est pas largement supportée par les différents navigateurs, elle est utilisable pour du code dédié aux applications Firefox OS.

Résumé

Cette méthode est utilisée pour faire une requête de blocage de mise en veille de n'importe quelle ressource de l'appareil. Elle renvoie un objet MozWakeLock utilisable pour garder une trace ou libérer le verrou de blocage.

Syntaxe

var lock = window.navigator.requestWakeLock(resourceName);
resourceName
Une chaîne de caractères représentant le nom de la ressource à verrouiller. Gaia utilise trois noms de ressources basiques : screen, cpu et wifi. Cependant toute application certifiée peut exposer de nouvelles ressources.

Valeur

navigator.requestWakeLock retourne un objet MozWakeLock qu'il est nécessaire d'utiliser pour libérer le verrou.

Note : quand la fenêtre qui a requis un ou plusieurs verrou est fermée ou supprimée, tout verrou impliqué est implicitement libéré. Une libération manuelle n'est pas nécessaire.

MozWakeLock

interface MozWakeLock
{
  readonly attribute DOMString topic

  void unlock();
}
topic
La chaîne de caractères contenant le nom de la ressource à verrouiller.
unlock
Une fonction qui doit être appelée pour libérer le verrou. Si plusieurs verrous ont été requis, chacun d'entre eux doit être libéré individuellement.

Note : appeler la méthode unlock sur un verrou déjà  libéré lancera une erreur de type : NS_ERROR_DOM_INVALID_STATE_ERR.

Exemple

var lock = window.navigator.requestWakeLock('screen');

window.addEventListener('unload', function () {
    lock.unlock();
});

Spécification

Cette API ne fait partie d'aucune spécification.

Voir aussi

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : fscholz, tregagnon, FredB, SphinxKnight, Goofy, darnuria
 Dernière mise à jour par : tregagnon,