mozilla

Compare Revisions

Download

Change Revisions

Revision 447401:

Revision 447401 by P.A. on

Revision 447431:

Revision 447431 by P.A. on

Title:
Download
Download
Slug:
Mozilla/JavaScript_code_modules/Downloads.jsm/Download
Mozilla/JavaScript_code_modules/Downloads.jsm/Download
Content:

Revision 447401
Revision 447431
nn25            <code><a href="/en-US/docs/Mozilla/JavaScript_code_mo
 >dules/Promise.jsm/Promise" title="/en-US/docs/Mozilla/JavaScript_
 >code_modules/Promise.jsm/Promise">Promise</a> <a href="#launch()"
 >>launch</a>();</code>
26          </td>
27        </tr>
28        <tr>
29          <td>
30            <code><a href="/en-US/docs/Mozilla/JavaScript_code_mo
 >dules/Promise.jsm/Promise" title="/en-US/docs/Mozilla/JavaScript_
 >code_modules/Promise.jsm/Promise">Promise</a> <a href="#showConta
 >iningDirectory()">showContainingDirectory</a>();</code>
31          </td>
32        </tr>
33        <tr>
34          <td>
nn40            <code><a href="/en-US/docs/Mozilla/JavaScript_code_mo
 >dules/Promise.jsm/Promise" title="/en-US/docs/Mozilla/JavaScript_
 >code_modules/Promise.jsm/Promise">Promise</a> <a href="#removePar
 >tialData()">removePartialData</a>();</code>
41          </td>
42        </tr>
43        <tr>
44          <td>
nn46          </td>
47        </tr>
48        <tr>
49          <td>
50            <code><a href="/en-US/docs/Mozilla/JavaScript_code_mo
 >dules/Promise.jsm/Promise" title="/en-US/docs/Mozilla/JavaScript_
 >code_modules/Promise.jsm/Promise">Promise</a> <a href="#finalize(
 >)">finalize</a>([optional] boolean aRemovePartialData);</code>
n278              <strong>Note:</strong> If this property is set to <n298              <strong>Note:</strong> If this property is set to <
>code>true</code>, care should be taken that partial data is remov>code>true</code>, care should be taken that partial data is remov
>ed before the reference to the download is discarded. This can be>ed before the reference to the download is discarded. This can be
> done using the <code>removePartialData</code> or the <code>final> done using the <a href="#removePartialData()" title="#removePart
>ize</code> methods.>ialData()"><code>removePartialData()</code></a> or the <a href="#
 >finalize()" title="#finalize()"><code>finalize()</code></a> metho
 >ds.
nn361    <h3 id="launch()">
362      launch()
363    </h3>
364    <p>
365      Opens or executes the target file after download has comple
 >ted.
366    </p>
367    <p>
368      If the <code>launcherPath</code> property is <code>null</co
 >de>, the file will be opened with the default application for the
 > MIME type specified in the <code>contentType</code> property. If
 > the content type is not available, an attempt will be made to ob
 >tain it from the extension of the target file.
369    </p>
370    <p>
371      If the <code>launcherPath</code> property is set, the file 
 >will be opened with the specified custom application.
372    </p>
373    <pre>
374Promise launch();
375</pre>
376    <h6 id="Parameters">
377      Parameters
378    </h6>
379    <p>
380      None.
381    </p>
382    <h6 id="Promise_resolves_to">
383      Promise resolves to
384    </h6>
385    <p>
386      <code>undefined</code> when the instruction to launch the f
 >ile has been successfully given to the operating system. Note tha
 >t the OS might still take a while until the file is actually laun
 >ched.
387    </p>
388    <h3 id="showContainingDirectory()">
389      showContainingDirectory()
390    </h3>
391    <p>
392      Shows the folder containing the target file, or where the t
 >arget file will be saved. This may be called at any time, even if
 > the download failed or is currently in progress.
393    </p>
394    <pre>
395Promise showContainingDirectory();
396</pre>
397    <h6 id="Parameters">
398      Parameters
399    </h6>
400    <p>
401      None.
402    </p>
403    <h6 id="Promise_resolves_to">
404      Promise resolves to
405    </h6>
406    <p>
407      <code>undefined</code> when the instruction to open the con
 >taining folder has been successfully given to the operating syste
 >m. Note that the OS might still take a while until the folder is 
 >actually opened.
408    </p>
nn445    <h3 id="removePartialData()">
446      removePartialData()
447    </h3>
448    <p>
449      Removes any partial data kept as part of a canceled or fail
 >ed download.
450    </p>
451    <p>
452      If the download is not canceled or failed, this method has 
 >no effect, and it returns a resolved promise. If the <code><a hre
 >f="#cancel()" title="#cancel()">cancel()</a></code> method was ca
 >lled but the cancellation process has not finished yet, this meth
 >od waits for the cancellation to finish, then removes the partial
 > data.
453    </p>
454    <p>
455      After this method has been called, if the <code>tryToKeepPa
 >rtialData</code> property is still <code>true</code> when the dow
 >nload is restarted, partial data will be retained during the new 
 >download attempt.
456    </p>
457    <pre>
458Promise removePartialData();
459</pre>
460    <h6 id="Parameters">
461      Parameters
462    </h6>
463    <p>
464      None.
465    </p>
466    <h6 id="Promise_resolves_to">
467      Promise resolves to
468    </h6>
469    <p>
470      <code>undefined</code> when the partial data has been succe
 >ssfully removed.
471    </p>
tt501    </p>
502    <h3 id="finalize()">
503      finalize()
504    </h3>
505    <p>
506      Ensures that the download is stopped, and optionally remove
 >s any partial data kept as part of a canceled or failed download.
 > After this method has been called, the download cannot be starte
 >d again.
507    </p>
508    <div class="note">
509      <strong>Note:</strong> This method should be used in place 
 >of the <code><a href="#cancel()" title="#cancel()">cancel()</a></
 >code> and <a href="#removePartialData()" title="#removePartialDat
 >a()"><code>removePartialData()</code></a> methods while shutting 
 >down or disposing of the download object, to prevent other caller
 >s from interfering with the operation. This is required because c
 >ancellation and other operations are asynchronous.
510    </div>
511    <pre>
512Promise finalize(
513  boolean aRemovePartialData
514);
515</pre>
516    <h6 id="Parameters">
517      Parameters
518    </h6>
519    <dl>
520      <dt>
521        <code>aRemovePartialData</code> {{optional_inline()}}
522      </dt>
523      <dd>
524        Whether any partially downloaded data should be removed a
 >fter the download has been stopped. The default is <code>false</c
 >ode>.
525      </dd>
526    </dl>
527    <h6 id="Promise_resolves_to">
528      Promise resolves to
529    </h6>
530    <p>
531      <code>undefined</code> when the operation has finished succ
 >essfully.

Back to History