window.navigator.requestWakeLock

  • Raccourci de la révision : Web/API/window.navigator.requestWakeLock
  • Titre de la révision : window.navigator.requestWakeLock
  • ID de la révision : 435935
  • Créé :
  • Créateur : tregagnon
  • Version actuelle ? Oui
  • Commentaire

Contenu de la révision

{{ non-standard_header() }}

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 {{ anch("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 {{anch("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

  • {{domxref("window.navigator.mozPower","navigator.mozPower")}}

Source de la révision

<p>{{ non-standard_header() }}</p>
<h2 id="Summary" name="Summary">Résumé</h2>
<p>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 {{ anch("MozWakeLock") }} utilisable pour garder une trace ou libérer le verrou de blocage.</p>
<h2 id="Syntax" name="Syntax">Syntaxe</h2>
<pre class="eval">
var lock = window.navigator.requestWakeLock(resourceName);
</pre>
<dl>
  <dt>
    resourceName</dt>
  <dd>
    Une chaîne de caractères représentant le nom de la ressource à verrouiller. <a href="/en-US/docs/Mozilla/Firefox_OS/Platform/Gaia" title="/en-US/docs/Mozilla/Firefox_OS/Platform/Gaia">Gaia</a> utilise trois noms de ressources basiques : <code>screen</code>, <code>cpu</code> et <code>wifi.</code> Cependant toute application certifiée peut exposer de nouvelles ressources.</dd>
</dl>
<h2 id="Value" name="Value">Valeur</h2>
<p><code>navigator.requestWakeLock</code> retourne un objet {{anch("MozWakeLock")}} qu'il est nécessaire d'utiliser pour libérer le verrou.</p>
<div class="note">
  <p><strong>Note :</strong> 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.</p>
</div>
<h3 id="MozWakeLock">MozWakeLock</h3>
<pre>
interface MozWakeLock
{
  readonly attribute DOMString topic

  void unlock();
}</pre>
<dl>
  <dt>
    <code>topic</code></dt>
  <dd>
    La chaîne de caractères contenant le nom de la ressource à verrouiller.</dd>
  <dt>
    <code>unlock</code></dt>
  <dd>
    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.</dd>
</dl>
<div class="note">
  <p><strong>Note :</strong> appeler la méthode<code> unlock </code>sur un verrou déjà&nbsp; libéré lancera une erreur de type : <code>NS_ERROR_DOM_INVALID_STATE_ERR</code>.</p>
</div>
<h2 id="Specification" name="Specification">Exemple</h2>
<pre class="brush: js">
var lock = window.navigator.requestWakeLock('screen');

window.addEventListener('unload', function () {
    lock.unlock();
});</pre>
<h2 id="Specification" name="Specification">Spécification</h2>
<p>Cette API ne fait partie d'aucune spécification.</p>
<h2 id="Voir_aussi">Voir aussi</h2>
<ul>
  <li>{{domxref("window.navigator.mozPower","navigator.mozPower")}}</li>
</ul>
Revenir à cette révision