mo2/python-plugins-doc
0
0
Fork 0
mirror of https://github.com/ModOrganizer2/python-plugins-doc.git synced 2026-07-27 14:07:44 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
3687a1c332bf270a8c1d0347612376864d5f3982
python-plugins-doc/api/mobase.IModRepositoryBridge.html
T

528 lines
29 KiB
HTML
Raw Normal View History

Deploying to master from @ 6e9912d1ef483ea6a0c58c4e5cea03720a47af61 🚀
2020-09-24 13:47:11 +00:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>IModRepositoryBridge &mdash; MO2 Python Plugin API 2.3rc1 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
Deploying to master from @ c60d1ac92f42de9a9cffa86064c76f4d9060f017 🚀
2020-09-24 14:17:15 +00:00
<link rel="shortcut icon" href="../_static/mo2.ico"/>
Deploying to master from @ 6e9912d1ef483ea6a0c58c4e5cea03720a47af61 🚀
2020-09-24 13:47:11 +00:00
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="IOrganizer" href="mobase.IOrganizer.html" />
<link rel="prev" title="IModList" href="mobase.IModList.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home" alt="Documentation Home"> MO2 Python Plugin API
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../setup-tools.html">Setting up the environment</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../setup-tools.html#required-tools">Required tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="../setup-tools.html#preparation">Preparation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../setup-tools.html#get-the-mobase-stubs">1. Get the <code class="docutils literal notranslate"><span class="pre">mobase</span></code> stubs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../setup-tools.html#configure-visual-studio-code-for-mobase">2. Configure Visual Studio Code for <code class="docutils literal notranslate"><span class="pre">mobase</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../setup-tools.html#configure-mypy-to-find-the-mobase-stubs">3. Configure <code class="docutils literal notranslate"><span class="pre">mypy</span></code> to find the <code class="docutils literal notranslate"><span class="pre">mobase</span></code> stubs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../setup-tools.html#testing-the-setup">Testing the setup</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../plugin-types.html">Type of Plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#installers">Installers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#previewers">Previewers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#mod-page">Mod Page</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#game">Game</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#tool">Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#proxies">Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#free-plugins"><em>Free Plugins</em></a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#extension-interfaces">Extension Interfaces</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin-types.html#diagnose">Diagnose</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin-types.html#file-mappings">File Mappings</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../writing-plugins.html">Writing Plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../writing-plugins.html#getting-started">Getting started</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#single-file-plugins">Single file plugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#module-plugins">Module Plugins</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../writing-plugins.html#writing-the-plugin">Writing the plugin</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#iplugin-interface"><code class="docutils literal notranslate"><span class="pre">IPlugin</span></code> interface</a></li>
</ul>
</li>
Deploying to master from @ 822dfc161e2a059d5d135e3e4043822f4ae71890 🚀
2020-10-07 18:49:09 +00:00
<li class="toctree-l2"><a class="reference internal" href="../writing-plugins.html#examples">Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#tutorial-plugins">Tutorial Plugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#official-plugins">Official Plugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#unofficial-plugins">Unofficial Plugins</a></li>
</ul>
</li>
Deploying to master from @ 6e9912d1ef483ea6a0c58c4e5cea03720a47af61 🚀
2020-09-24 13:47:11 +00:00
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a><ul>
<li class="toctree-l2"><a class="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>
<li class="toctree-l2"><a class="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>
<li class="toctree-l2"><a class="reference internal" href="../faq.html#why-are-my-isinstance-x-qobject-and-isinstance-y-qwidget-not-working">3. Why are my <code class="docutils literal notranslate"><span class="pre">isinstance(x,</span> <span class="pre">QObject)</span></code> and <code class="docutils literal notranslate"><span class="pre">isinstance(y,</span> <span class="pre">QWidget)</span></code> not working?</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="../mobase.html"><code class="docutils literal notranslate"><span class="pre">mobase</span></code> API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../mobase.html#functions">Functions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mobase.getFileVersion.html">getFileVersion</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.getIconForExecutable.html">getIconForExecutable</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.getProductVersion.html">getProductVersion</a></li>
</ul>
</li>
<li class="toctree-l2 current"><a class="reference internal" href="../mobase.html#classes">Classes</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="mobase.BSAInvalidation.html">BSAInvalidation</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.DataArchives.html">DataArchives</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ExecutableForcedLoadSetting.html">ExecutableForcedLoadSetting</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ExecutableInfo.html">ExecutableInfo</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.FileInfo.html">FileInfo</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.FileTreeEntry.html">FileTreeEntry</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.GamePlugins.html">GamePlugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.GuessQuality.html">GuessQuality</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.GuessedString.html">GuessedString</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IDownloadManager.html">IDownloadManager</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IFileTree.html">IFileTree</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IInstallationManager.html">IInstallationManager</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IModInterface.html">IModInterface</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IModList.html">IModList</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">IModRepositoryBridge</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IOrganizer.html">IOrganizer</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPlugin.html">IPlugin</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginDiagnose.html">IPluginDiagnose</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginFileMapper.html">IPluginFileMapper</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginGame.html">IPluginGame</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginInstaller.html">IPluginInstaller</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginInstallerCustom.html">IPluginInstallerCustom</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginInstallerSimple.html">IPluginInstallerSimple</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginList.html">IPluginList</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginModPage.html">IPluginModPage</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginPreview.html">IPluginPreview</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginTool.html">IPluginTool</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IProfile.html">IProfile</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ISaveGame.html">ISaveGame</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ISaveGameInfoWidget.html">ISaveGameInfoWidget</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.InstallResult.html">InstallResult</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.InterfaceNotImplemented.html">InterfaceNotImplemented</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.LoadOrderMechanism.html">LoadOrderMechanism</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.LocalSavegames.html">LocalSavegames</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.Mapping.html">Mapping</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ModDataChecker.html">ModDataChecker</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ModDataContent.html">ModDataContent</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ModRepositoryFileInfo.html">ModRepositoryFileInfo</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ModState.html">ModState</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.PluginSetting.html">PluginSetting</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.PluginState.html">PluginState</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ProfileSetting.html">ProfileSetting</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ReleaseType.html">ReleaseType</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.SaveGameInfo.html">SaveGameInfo</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ScriptExtender.html">ScriptExtender</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.SortMechanism.html">SortMechanism</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.UnmanagedMods.html">UnmanagedMods</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.VersionInfo.html">VersionInfo</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.VersionScheme.html">VersionScheme</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">MO2 Python Plugin API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../mobase.html"><code class="docutils literal notranslate"><span class="pre">mobase</span></code> API</a> &raquo;</li>
<li>IModRepositoryBridge</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/mobase.IModRepositoryBridge.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="imodrepositorybridge">
<h1>IModRepositoryBridge<a class="headerlink" href="#imodrepositorybridge" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="mobase.IModRepositoryBridge">
<em class="property">class </em><code class="sig-prename descclassname">mobase.</code><code class="sig-name descname">IModRepositoryBridge</code><a class="headerlink" href="#mobase.IModRepositoryBridge" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">PyQt5.QtCore.QObject</span></code></p>
<p class="rubric">Attributes Summary</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.descriptionAvailable" title="mobase.IModRepositoryBridge.descriptionAvailable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">descriptionAvailable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.downloadURLsAvailable" title="mobase.IModRepositoryBridge.downloadURLsAvailable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">downloadURLsAvailable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.endorsementToggled" title="mobase.IModRepositoryBridge.endorsementToggled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">endorsementToggled</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.endorsementsAvailable" title="mobase.IModRepositoryBridge.endorsementsAvailable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">endorsementsAvailable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.fileInfoAvailable" title="mobase.IModRepositoryBridge.fileInfoAvailable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fileInfoAvailable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.filesAvailable" title="mobase.IModRepositoryBridge.filesAvailable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">filesAvailable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.requestFailed" title="mobase.IModRepositoryBridge.requestFailed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requestFailed</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.trackedModsAvailable" title="mobase.IModRepositoryBridge.trackedModsAvailable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trackedModsAvailable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.trackingToggled" title="mobase.IModRepositoryBridge.trackingToggled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trackingToggled</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<p class="rubric">Methods Summary</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.requestDescription" title="mobase.IModRepositoryBridge.requestDescription"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requestDescription</span></code></a>(game_name, mod_id, user_data)</p></td>
<td><p>Request description of a mod.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.requestDownloadURL" title="mobase.IModRepositoryBridge.requestDownloadURL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requestDownloadURL</span></code></a>(game_name, mod_id, …)</p></td>
<td><p>Request download URL for mod file.0</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.requestFileInfo" title="mobase.IModRepositoryBridge.requestFileInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requestFileInfo</span></code></a>(game_name, mod_id, file_id, …)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">param game_name</dt>
<dd class="field-odd"><p>Name of the game containing the mod.</p>
</dd>
</dl>
</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.requestFiles" title="mobase.IModRepositoryBridge.requestFiles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requestFiles</span></code></a>(game_name, mod_id, user_data)</p></td>
<td><p>Request the list of files belonging to a mod.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.requestToggleEndorsement" title="mobase.IModRepositoryBridge.requestToggleEndorsement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requestToggleEndorsement</span></code></a>(game_name, mod_id, …)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">param game_name</dt>
<dd class="field-odd"><p>Name of the game containing the mod.</p>
</dd>
</dl>
</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes Documentation</p>
<dl class="attribute">
<dt id="mobase.IModRepositoryBridge.descriptionAvailable">
<code class="sig-name descname">descriptionAvailable</code><em class="property">: PyQt5.QtCore.pyqtSignal</em><em class="property"> = Ellipsis</em><a class="headerlink" href="#mobase.IModRepositoryBridge.descriptionAvailable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="mobase.IModRepositoryBridge.downloadURLsAvailable">
<code class="sig-name descname">downloadURLsAvailable</code><em class="property">: PyQt5.QtCore.pyqtSignal</em><em class="property"> = Ellipsis</em><a class="headerlink" href="#mobase.IModRepositoryBridge.downloadURLsAvailable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="mobase.IModRepositoryBridge.endorsementToggled">
<code class="sig-name descname">endorsementToggled</code><em class="property">: PyQt5.QtCore.pyqtSignal</em><em class="property"> = Ellipsis</em><a class="headerlink" href="#mobase.IModRepositoryBridge.endorsementToggled" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="mobase.IModRepositoryBridge.endorsementsAvailable">
<code class="sig-name descname">endorsementsAvailable</code><em class="property">: PyQt5.QtCore.pyqtSignal</em><em class="property"> = Ellipsis</em><a class="headerlink" href="#mobase.IModRepositoryBridge.endorsementsAvailable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="mobase.IModRepositoryBridge.fileInfoAvailable">
<code class="sig-name descname">fileInfoAvailable</code><em class="property">: PyQt5.QtCore.pyqtSignal</em><em class="property"> = Ellipsis</em><a class="headerlink" href="#mobase.IModRepositoryBridge.fileInfoAvailable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="mobase.IModRepositoryBridge.filesAvailable">
<code class="sig-name descname">filesAvailable</code><em class="property">: PyQt5.QtCore.pyqtSignal</em><em class="property"> = Ellipsis</em><a class="headerlink" href="#mobase.IModRepositoryBridge.filesAvailable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="mobase.IModRepositoryBridge.requestFailed">
<code class="sig-name descname">requestFailed</code><em class="property">: PyQt5.QtCore.pyqtSignal</em><em class="property"> = Ellipsis</em><a class="headerlink" href="#mobase.IModRepositoryBridge.requestFailed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="mobase.IModRepositoryBridge.trackedModsAvailable">
<code class="sig-name descname">trackedModsAvailable</code><em class="property">: PyQt5.QtCore.pyqtSignal</em><em class="property"> = Ellipsis</em><a class="headerlink" href="#mobase.IModRepositoryBridge.trackedModsAvailable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="mobase.IModRepositoryBridge.trackingToggled">
<code class="sig-name descname">trackingToggled</code><em class="property">: PyQt5.QtCore.pyqtSignal</em><em class="property"> = Ellipsis</em><a class="headerlink" href="#mobase.IModRepositoryBridge.trackingToggled" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p class="rubric">Methods Documentation</p>
<dl class="method">
<dt id="mobase.IModRepositoryBridge.requestDescription">
<code class="sig-name descname">requestDescription</code><span class="sig-paren">(</span><em class="sig-param">game_name</em>, <em class="sig-param">mod_id</em>, <em class="sig-param">user_data</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestDescription" title="Permalink to this definition">¶</a></dt>
<dd><p>Request description of a mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>user_data</strong> – User data to be returned with the result.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModRepositoryBridge.requestDownloadURL">
<code class="sig-name descname">requestDownloadURL</code><span class="sig-paren">(</span><em class="sig-param">game_name</em>, <em class="sig-param">mod_id</em>, <em class="sig-param">file_id</em>, <em class="sig-param">user_data</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestDownloadURL" title="Permalink to this definition">¶</a></dt>
<dd><p>Request download URL for mod file.0</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>file_id</strong> – ID of the file for which a URL should be returned.</p></li>
<li><p><strong>user_data</strong> – User data to be returned with the result.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModRepositoryBridge.requestFileInfo">
<code class="sig-name descname">requestFileInfo</code><span class="sig-paren">(</span><em class="sig-param">game_name</em>, <em class="sig-param">mod_id</em>, <em class="sig-param">file_id</em>, <em class="sig-param">user_data</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestFileInfo" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>file_id</strong> – ID of the file for which information is requested.</p></li>
<li><p><strong>user_data</strong> – User data to be returned with the result.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModRepositoryBridge.requestFiles">
<code class="sig-name descname">requestFiles</code><span class="sig-paren">(</span><em class="sig-param">game_name</em>, <em class="sig-param">mod_id</em>, <em class="sig-param">user_data</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestFiles" title="Permalink to this definition">¶</a></dt>
<dd><p>Request the list of files belonging to a mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>user_data</strong> – User data to be returned with the result.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModRepositoryBridge.requestToggleEndorsement">
<code class="sig-name descname">requestToggleEndorsement</code><span class="sig-paren">(</span><em class="sig-param">game_name</em>, <em class="sig-param">mod_id</em>, <em class="sig-param">mod_version</em>, <em class="sig-param">endorse</em>, <em class="sig-param">user_data</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestToggleEndorsement" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>mod_version</strong> – Version of the mod.</p></li>
<li><p><strong>endorse</strong> – </p></li>
<li><p><strong>user_data</strong> – User data to be returned with the result.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="mobase.IOrganizer.html" class="btn btn-neutral float-right" title="IOrganizer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="mobase.IModList.html" class="btn btn-neutral float-left" title="IModList" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, Holt59
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue Copy Permalink