mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed ae10c4d87a to master with MkDocs 1.2.3 and mike 1.1.2
This commit is contained in:
GitHub Action committed
1 parent
5893f70252
commit
272bf390e2
59 files changed
+745
-13402
No files matched your search
@@ -974,6 +974,13 @@
|
||||
<nav class="md-nav" aria-label="Methods">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#setlensextensiondependencies" class="md-nav__link">
|
||||
[setLensExtensionDependencies]
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#addcatalogcategoryfilter" class="md-nav__link">
|
||||
addCatalogCategoryFilter
|
||||
@@ -1101,6 +1108,7 @@
|
||||
</ul>
|
||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#[setlensextensiondependencies]">[setLensExtensionDependencies]</a></li>
|
||||
<li><a href="./#addcatalogcategoryfilter">addCatalogCategoryFilter</a></li>
|
||||
<li><a href="./#addcatalogfilter">addCatalogFilter</a></li>
|
||||
<li><a href="./#disable">disable</a></li>
|
||||
@@ -1135,7 +1143,7 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@22036</p>
|
||||
<p>LensExtension.__@Disposers@21221</p>
|
||||
<hr />
|
||||
<h3 id="apppreferences">appPreferences<a class="headerlink" href="#apppreferences" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>appPreferences</strong>: <a href="../../interfaces/Common.Types.AppPreferenceRegistration/"><code>AppPreferenceRegistration</code></a>[] = <code>[]</code></p>
|
||||
@@ -1235,10 +1243,32 @@
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.version</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="setlensextensiondependencies">[setLensExtensionDependencies]<a class="headerlink" href="#setlensextensiondependencies" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>[setLensExtensionDependencies]</strong>(<code>dependencies</code>): <code>void</code></p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>dependencies</code></td>
|
||||
<td align="left"><code>LensExtensionDependencies</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@setLensExtensionDependencies@21225</p>
|
||||
<hr />
|
||||
<h3 id="addcatalogcategoryfilter">addCatalogCategoryFilter<a class="headerlink" href="#addcatalogcategoryfilter" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>addCatalogCategoryFilter</strong>(<code>fn</code>): <code>Disposer</code></p>
|
||||
<p>Add a filtering function for the catalog categories. This will be removed if the extension is disabled.</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1255,14 +1285,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>Disposer</code></p>
|
||||
<p>A function to clean up the filter</p>
|
||||
<hr />
|
||||
<h3 id="addcatalogfilter">addCatalogFilter<a class="headerlink" href="#addcatalogfilter" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>addCatalogFilter</strong>(<code>fn</code>): <code>Disposer</code></p>
|
||||
<p>Add a filtering function for the catalog entities. This will be removed if the extension is disabled.</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1279,20 +1309,20 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Disposer</code></p>
|
||||
<p>A function to clean up the filter</p>
|
||||
<hr />
|
||||
<h3 id="disable">disable<a class="headerlink" href="#disable" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>disable</strong>(): <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.disable</p>
|
||||
<hr />
|
||||
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>enable</strong>(<code>register</code>): <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1307,9 +1337,9 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.enable</p>
|
||||
<hr />
|
||||
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
|
||||
@@ -1318,9 +1348,9 @@
|
||||
folder is for the sole use of this extension.</p>
|
||||
<p>Note: there is no security done on this folder, only obfuscation of the
|
||||
folder name.</p>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>string</code>></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.getExtensionFileFolder</p>
|
||||
<hr />
|
||||
<h3 id="isenabledforcluster">isEnabledForCluster<a class="headerlink" href="#isenabledforcluster" title="Permanent link">#</a></h3>
|
||||
@@ -1328,7 +1358,7 @@ folder name.</p>
|
||||
<p>Defines if extension is enabled for a given cluster. This method is only
|
||||
called when the extension is created within a cluster frame.</p>
|
||||
<p>The default implementation is to return <code>true</code></p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1343,7 +1373,7 @@ called when the extension is created within a cluster frame.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>Boolean</code>></p>
|
||||
<hr />
|
||||
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
|
||||
@@ -1363,7 +1393,7 @@ called when the extension is created within a cluster frame.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1382,21 +1412,21 @@ called when the extension is created within a cluster frame.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<hr />
|
||||
<h3 id="onactivate">onActivate<a class="headerlink" href="#onactivate" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.onActivate</p>
|
||||
<hr />
|
||||
<h3 id="ondeactivate">onDeactivate<a class="headerlink" href="#ondeactivate" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onDeactivate</strong>(): <code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.onDeactivate</p>
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user