diff options
Diffstat (limited to 'files/fr/mozilla/add-ons/webextensions/api/history/addurl/index.md')
-rw-r--r-- | files/fr/mozilla/add-ons/webextensions/api/history/addurl/index.md | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/files/fr/mozilla/add-ons/webextensions/api/history/addurl/index.md b/files/fr/mozilla/add-ons/webextensions/api/history/addurl/index.md new file mode 100644 index 0000000000..089ce53843 --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/history/addurl/index.md @@ -0,0 +1,147 @@ +--- +title: history.addUrl() +slug: Mozilla/Add-ons/WebExtensions/API/history/addUrl +tags: + - API + - Add-ons + - Extensions + - History + - Method + - Non-standard + - Reference + - WebExtensions + - addUrl +translation_of: Mozilla/Add-ons/WebExtensions/API/history/addUrl +--- +<div>{{AddonSidebar()}}</div> + +<p>Ajoute un enregistrement à l'historique du navigateur d'une visite à l'URL donnée. L'heure de la visite est enregistrée comme l'heure de l'appel, et le {{WebExtAPIRef("history.TransitionType", "TransitionType")}} est enregistré comme "liens".</p> + +<p>C'est une fonction asynchrone qui renvoie une <code><a href="/fr/docs/Web/JavaScript/Reference/Objets_globaux/Promise">Promise</a></code>.</p> + +<h2 id="Syntaxe">Syntaxe</h2> + +<pre class="brush: js">var addingUrl = browser.history.addUrl( + details // object +) +</pre> + +<h3 id="Paramètres">Paramètres</h3> + +<dl> + <dt><code>details</code></dt> + <dd><p><code>object</code>. Objet contenant l'URL à ajouter.</p> + <dl> + <dt><code>url</code></dt> + <dd><code>string</code>. L'URL à ajouter.</dd> + <dt><code>title</code>{{optional_inline}}</dt> + <dd>string: Le titre de la page. Si ce n'est pas fourni, le titre sera enregistré comme <code>null</code>.</dd> + <dt><code>transition</code>{{optional_inline}}</dt> + <dd>{{WebExtAPIRef("history.TransitionType")}}. Décrit comment le navigateur a navigué vers la page à cette occasion. Si ce n'est pas fourni, un type de transition de "lien" sera enregistré.</dd> + <dt><code>visitTime</code>{{optional_inline}}</dt> + <dd><code>number</code> ou <code>string</code> ou <code>object</code>. Cela peut être représenté par: un objet <code><a href="/fr/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a></code>, une <a href="http://www.iso.org/iso/home/standards/iso8601.htm">chaîne de date ISO 8601</a>, ou le nombre de millisecondes depuis l'époque. Définit le temps de visite à cette valeur. Si ce n'est pas fourni, l'heure actuelle sera enregistrée.</dd> + </dl> + </dd> +</dl> + +<h3 id="Valeur_retournée">Valeur retournée</h3> + +<p>Une <code><a href="/fr/docs/Web/JavaScript/Reference/Objets_globaux/Promise">Promise</a></code> sera rempli sans paramètres lorsque l'élément a été ajouté.</p> + +<h2 id="Compatibilité_du_navigateur">Compatibilité du navigateur</h2> + +<p>{{Compat("webextensions.api.history.addUrl")}}</p> + +<h2 id="Exemples">Exemples</h2> + +<p>Ajoutez un enregistrement d'une visite à "https://example.org/", puis vérifiez que la nouvelle visite a été enregistrée en recherchant l'historique de l'élément le plus récent et en l'enregistrant :</p> + +<pre class="brush: js">function onGot(results) { + if (results.length) { + console.log(results[0].url); + console.log(new Date(results[0].lastVisitTime)); + } +} + +function onAdded() { + var searching = browser.history.search({ + text: "https://example.org/", + startTime: 0, + maxResults: 1 + }); + searching.then(onGot); +} + +var addingUrl = browser.history.addUrl({url: "https://example.org/"}); +addingUrl.then(onAdded);</pre> + +<p>Ajouter un enregistrement d'une visite à "https://example.org", mais lui donner une <code>visitTime</code> de 24 heures dans le passé, et une <code>transition</code> "typed":</p> + +<pre class="brush: js">const DAY = 24 * 60* 60 * 1000; + +function oneDayAgo() { + return Date.now() - DAY; +} + +function onGot(visits) { + for (visit of visits) { + console.log(new Date(visit.visitTime)); + console.log(visit.transition); + } +} + +function onAdded() { + var gettingVisits = browser.history.getVisits({ + url: "https://example.org/" + }); + + gettingVisits.then(onGot); +} + +var addingUrl = browser.history.addUrl({ + url: "https://example.org/", + visitTime: oneDayAgo(), + transition: "typed" +}); + +addingUrl.then(onAdded);</pre> + +<p>{{WebExtExamples}}</p> + +<div class="note"><p><strong>Note :</strong></p> + +<p>Cette API est basée sur l'API Chromium <a href="https://developer.chrome.com/extensions/history"><code>chrome.history</code></a>. Cette documentation est dérivée de <a href="https://chromium.googlesource.com/chromium/src/+/master/chrome/common/extensions/api/history.json"><code>history.json</code></a> dans le code de Chromium.</p> + +<p>Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.</p> +</div> + +<div class="hidden"> +<pre>// Copyright 2015 The Chromium Authors. All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +</pre> +</div> |