<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#get-the-mobase-stubs">1. Get the <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code> stubs</a></li>
<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#configure-visual-studio-code-for-mobase">2. Configure Visual Studio Code for <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code></a></li>
<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#configure-mypy-to-find-the-mobase-stubs">3. Configure <codeclass="docutils literal notranslate"><spanclass="pre">mypy</span></code> to find the <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code> stubs</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#why-is-mo2-throwing-an-exception-when-i-try-to-create-a-type-inheriting-one-of-mo2-class">1. Why is MO2 throwing an exception when I try to create a type inheriting one of MO2 class?</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#how-can-i-be-sure-to-implement-all-the-required-methods-when-creating-a-plugin">2. How can I be sure to implement all the required methods when creating a plugin?</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#why-are-my-isinstance-x-qobject-and-isinstance-y-qwidget-not-working">3. Why are my <codeclass="docutils literal notranslate"><spanclass="pre">isinstance(x,</span><spanclass="pre">QObject)</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">isinstance(y,</span><spanclass="pre">QWidget)</span></code> not working?</a></li>
<h1>IDownloadManager<aclass="headerlink"href="#idownloadmanager"title="Permalink to this headline">¶</a></h1>
<dlclass="class">
<dtid="mobase.IDownloadManager">
<emclass="property">class </em><codeclass="sig-prename descclassname">mobase.</code><codeclass="sig-name descname">IDownloadManager</code><aclass="headerlink"href="#mobase.IDownloadManager"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">downloadPath</code><spanclass="sig-paren">(</span><emclass="sig-param">id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IDownloadManager.downloadPath"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve the (absolute) path of the specified download.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>id</strong>– ID of the download.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The absolute path to the file corresponding to the given download. This file</p>
</dd>
</dl>
<p>may not exist yet if the download is incomplete.</p>
<codeclass="sig-name descname">onDownloadComplete</code><spanclass="sig-paren">(</span><emclass="sig-param">callback</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IDownloadManager.onDownloadComplete"title="Permalink to this definition">¶</a></dt>
<dd><p>Installs a handler to be called when a download completes.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>callback</strong>– The function to be called when a download complete. The parameter is the download ID.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if the handler was installed properly (there are currently no reasons for this to fail).</p>
<codeclass="sig-name descname">onDownloadFailed</code><spanclass="sig-paren">(</span><emclass="sig-param">callback</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IDownloadManager.onDownloadFailed"title="Permalink to this definition">¶</a></dt>
<dd><p>Installs a handler to be called when a download fails.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>callback</strong>– The function to be called when a download fails. The parameter is the download ID.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if the handler was installed properly (there are currently no reasons for this to fail).</p>
<codeclass="sig-name descname">onDownloadPaused</code><spanclass="sig-paren">(</span><emclass="sig-param">callback</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IDownloadManager.onDownloadPaused"title="Permalink to this definition">¶</a></dt>
<dd><p>Installs a handler to be called when a download is paused.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>callback</strong>– The function to be called when a download is paused. The parameter is the download ID.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if the handler was installed properly (there are currently no reasons for this to fail).</p>
<codeclass="sig-name descname">onDownloadRemoved</code><spanclass="sig-paren">(</span><emclass="sig-param">callback</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IDownloadManager.onDownloadRemoved"title="Permalink to this definition">¶</a></dt>
<dd><p>Installs a handler to be called when a download is removed.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>callback</strong>– The function to be called when a download is removed. The parameter is the download ID.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if the handler was installed properly (there are currently no reasons for this to fail).</p>
<codeclass="sig-name descname">startDownloadNexusFile</code><spanclass="sig-paren">(</span><emclass="sig-param">mod_id</em>, <emclass="sig-param">file_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IDownloadManager.startDownloadNexusFile"title="Permalink to this definition">¶</a></dt>
<dd><p>Download a file from www.nexusmods.com/<game>. <game> is always the game
currently being managed.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>mod_id</strong>– ID of the mod to download the file from.</p></li>
<li><p><strong>file_id</strong>– ID of the file to download.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>An ID identifying the download.</p>
<codeclass="sig-name descname">startDownloadURLs</code><spanclass="sig-paren">(</span><emclass="sig-param">urls</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IDownloadManager.startDownloadURLs"title="Permalink to this definition">¶</a></dt>
<dd><p>Download a file by url.</p>
<p>The list can contain alternative URLs to allow the download manager to switch
in case of download problems</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>urls</strong>– List of urls to download from.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>An ID identifying the download.</p>
