binaryninja/personal/api-docs/binaryninja.pluginmanager.RepoPlugin.html

341 lines
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>binaryninja.pluginmanager.RepoPlugin &mdash; Binary Ninja API Documentation v1.1</title>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/other.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Binary Ninja API Documentation v1.1" href="index.html"/>
<link rel="up" title="pluginmanager module" href="binaryninja.pluginmanager-module.html"/>
<link rel="next" title="binaryninja.pluginmanager.Repository" href="binaryninja.pluginmanager.Repository.html"/>
<link rel="prev" title="pluginmanager module" href="binaryninja.pluginmanager-module.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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"> Binary Ninja API
</a>
<div class="version">
<script>
window.addEventListener("load", function() {
var ver = document.getElementsByClassName("version");
ver[0].innerHTML = DOCUMENTATION_OPTIONS['VERSION'];
});
</script>
</div>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="binaryninja.architecture-module.html">architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.atexit-module.html">atexit</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.basicblock-module.html">basicblock</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.binaryview-module.html">binaryview</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.callingconvention-module.html">callingconvention</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.databuffer-module.html">databuffer</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.datarender-module.html">datarender</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.demangle-module.html">demangle</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.downloadprovider-module.html">downloadprovider</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.enums-module.html">enums</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.fileaccessor-module.html">fileaccessor</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.filemetadata-module.html">filemetadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.flowgraph-module.html">flowgraph</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.function-module.html">function</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.functionrecognizer-module.html">functionrecognizer</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.highlight-module.html">highlight</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.interaction-module.html">interaction</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lineardisassembly-module.html">lineardisassembly</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.log-module.html">log</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lowlevelil-module.html">lowlevelil</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mainthread-module.html">mainthread</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mediumlevelil-module.html">mediumlevelil</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.metadata-module.html">metadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.numbers-module.html">numbers</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.platform-module.html">platform</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.plugin-module.html">plugin</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="binaryninja.pluginmanager-module.html">pluginmanager</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">binaryninja.pluginmanager.RepoPlugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.pluginmanager.Repository.html">binaryninja.pluginmanager.Repository</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.pluginmanager.RepositoryManager.html">binaryninja.pluginmanager.RepositoryManager</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.pluginmanager.range.html">binaryninja.pluginmanager.range</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.scriptingprovider-module.html">scriptingprovider</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.settings-module.html">settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.transform-module.html">transform</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.types-module.html">types</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.undoaction-module.html">undoaction</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.update-module.html">update</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Binary Ninja 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">Docs</a> &raquo;</li>
<li><a href="binaryninja.pluginmanager-module.html">pluginmanager module</a> &raquo;</li>
<li>binaryninja.pluginmanager.RepoPlugin</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/binaryninja.pluginmanager.RepoPlugin.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="binaryninja-pluginmanager-repoplugin">
<h1>binaryninja.pluginmanager.RepoPlugin<a class="headerlink" href="#binaryninja-pluginmanager-repoplugin" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="binaryninja.pluginmanager.RepoPlugin">
<em class="property">class </em><code class="descname">RepoPlugin</code><span class="sig-paren">(</span><em>handle</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepoPlugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin" title="Permalink to this definition"></a></dt>
<dd><p><a href="#id1"><span class="problematic" id="id2">``</span></a>RepoPlugin` is mostly read-only, however you can install/uninstall enable/disable plugins. RepoPlugins are
created by parsing the plugins.json in a plugin repository.</p>
<dl class="method">
<dt id="binaryninja.pluginmanager.RepoPlugin.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>handle</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepoPlugin.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.__init__" title="Permalink to this definition"></a></dt>
<dd><p>x.__init__(…) initializes x; see help(type(x)) for signature</p>
</dd></dl>
<p class="rubric">Methods</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#binaryninja.pluginmanager.RepoPlugin.__init__" title="binaryninja.pluginmanager.RepoPlugin.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(handle)</td>
<td>x.__init__(…) initializes x; see help(type(x)) for signature</td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.api" title="binaryninja.pluginmanager.RepoPlugin.api"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api</span></code></a></td>
<td>string indicating the API used by the plugin</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.description" title="binaryninja.pluginmanager.RepoPlugin.description"><code class="xref py py-obj docutils literal notranslate"><span class="pre">description</span></code></a></td>
<td>String short description of the plugin</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.enabled" title="binaryninja.pluginmanager.RepoPlugin.enabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enabled</span></code></a></td>
<td>Boolean True if the plugin is currently enabled, False otherwise</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.installed" title="binaryninja.pluginmanager.RepoPlugin.installed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">installed</span></code></a></td>
<td>Boolean True if the plugin is installed, False otherwise</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.license" title="binaryninja.pluginmanager.RepoPlugin.license"><code class="xref py py-obj docutils literal notranslate"><span class="pre">license</span></code></a></td>
<td>String short license description (ie MIT, BSD, GPLv2, etc)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.license_text" title="binaryninja.pluginmanager.RepoPlugin.license_text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">license_text</span></code></a></td>
<td>String complete license text for the given plugin</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.long_description" title="binaryninja.pluginmanager.RepoPlugin.long_description"><code class="xref py py-obj docutils literal notranslate"><span class="pre">long_description</span></code></a></td>
<td>String long description of the plugin</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.minimum_version" title="binaryninja.pluginmanager.RepoPlugin.minimum_version"><code class="xref py py-obj docutils literal notranslate"><span class="pre">minimum_version</span></code></a></td>
<td>String minimum version the plugin was tested on</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.name" title="binaryninja.pluginmanager.RepoPlugin.name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></a></td>
<td>String name of the plugin</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.path" title="binaryninja.pluginmanager.RepoPlugin.path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">path</span></code></a></td>
<td>Relative path from the base of the repository to the actual plugin</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.plugin_types" title="binaryninja.pluginmanager.RepoPlugin.plugin_types"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plugin_types</span></code></a></td>
<td>List of PluginType enumeration objects indicating the plugin type(s)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.update_status" title="binaryninja.pluginmanager.RepoPlugin.update_status"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_status</span></code></a></td>
<td>PluginUpdateStatus enumeration indicating if the plugin is up to date or not</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.url" title="binaryninja.pluginmanager.RepoPlugin.url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">url</span></code></a></td>
<td>String URL of the plugins git repository</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepoPlugin.version" title="binaryninja.pluginmanager.RepoPlugin.version"><code class="xref py py-obj docutils literal notranslate"><span class="pre">version</span></code></a></td>
<td>String version of the plugin</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="binaryninja.pluginmanager.Repository.html" class="btn btn-neutral float-right" title="binaryninja.pluginmanager.Repository" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="binaryninja.pluginmanager-module.html" class="btn btn-neutral" title="pluginmanager module" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015-2019, Vector 35 Inc.
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>