zadam/trilium
1
1
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2024-11-15 12:17:01 +08:00
Code Issues Projects Releases Packages Wiki Activity
trilium/docs/backend_api/BOption.html

1545 lines
17 KiB
HTML
Raw Normal View History

added jsdocs generated pages
2018-08-30 02:44:35 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
docs updated
2023-01-03 20:54:27 +08:00
<title>JSDoc: Class: BOption</title>
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
docs updated
2023-01-03 20:54:27 +08:00
<h1 class="page-title">Class: BOption</h1>
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
<section>
<header>
docs updated
2023-01-03 20:54:27 +08:00
<h2><span class="attribs"><span class="type-signature"></span></span>BOption<span class="signature">()</span><span class="type-signature"></span></h2>
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
API docs
2023-07-15 18:07:45 +08:00
<div class="class-description">Option represents a name-value pair, either directly configurable by the user or some system property.</div>
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
docs updated
2023-01-03 20:54:27 +08:00
<h4 class="name" id="BOption"><span class="type-signature"></span>new BOption<span class="signature">()</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
added getAllNotePaths, fixes #708
2019-11-17 02:07:32 +08:00
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
<dl class="details">
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line11">line 11</a>
</li></ul></dd>
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-21 03:40:47 +08:00
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
</div>
fix docs
2022-04-16 06:17:32 +08:00
<h3 class="subsection-title">Extends</h3>
<ul>
docs updated
2023-01-03 20:54:27 +08:00
<li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
fix docs
2022-04-16 06:17:32 +08:00
</ul>
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
fixed jsdoc script API generation, closes #2313
2021-11-11 04:30:54 +08:00
<h3 class="subsection-title">Members</h3>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
<h4 class="name" id="becca"><span class="type-signature">(protected) </span>becca<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 20:54:27 +08:00
<a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</li></ul></dd>
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line35">line 35</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</dl>
fixed jsdoc script API generation, closes #2313
2021-11-11 04:30:54 +08:00
<h4 class="name" id="isSynced"><span class="type-signature"></span>isSynced<span class="type-signature"> :boolean</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
script api docs
2023-05-31 20:00:37 +08:00
<a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line29">line 29</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-11 04:30:54 +08:00
</dl>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
script api docs
2023-05-31 20:00:37 +08:00
<a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line25">line 25</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-11 04:30:54 +08:00
</dl>
<h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
script api docs
2023-05-31 20:00:37 +08:00
<a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line31">line 31</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-11 04:30:54 +08:00
</dl>
<h4 class="name" id="value"><span class="type-signature"></span>value<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
script api docs
2023-05-31 20:00:37 +08:00
<a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line27">line 27</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
fix docs
2022-04-16 06:17:32 +08:00
</dl>
<h3 class="subsection-title">Methods</h3>
API docs
2023-06-30 02:54:58 +08:00
<h4 class="name" id="_getContent"><span class="type-signature">(protected) </span>_getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line250">line 250</a>
API docs
2023-06-30 02:54:58 +08:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
|
<span class="param-type">Buffer</span>
</dd>
</dl>
<h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractBeccaEntity.html#_setContent">AbstractBeccaEntity#_setContent</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
API docs
2023-06-30 02:54:58 +08:00
</li></ul></dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
<h4 class="name" id="beforeSaving"><span class="type-signature">(protected) </span>beforeSaving<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 20:54:27 +08:00
<a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</li></ul></dd>
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-30 02:54:58 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line20">line 20</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</dl>
jsdocs
2023-10-08 01:57:53 +08:00
<h4 class="name" id="generateHash"><span class="type-signature">(protected) </span>generateHash<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 20:54:27 +08:00
<a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</li></ul></dd>
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line59">line 59</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</dl>
jsdocs
2023-10-08 01:57:53 +08:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
jsdocs
2023-10-08 01:57:53 +08:00
<h4 class="name" id="getPojo"><span class="type-signature">(abstract, protected) </span>getPojo<span class="signature">()</span><span class="type-signature"></span></h4>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="AbstractBeccaEntity.html#getPojo">AbstractBeccaEntity#getPojo</a>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</li></ul></dd>
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line82">line 82</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</dl>
<h4 class="name" id="getPojoToSave"><span class="type-signature">(protected) </span>getPojoToSave<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 20:54:27 +08:00
<a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</li></ul></dd>
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</dl>
<h4 class="name" id="getUtcDateChanged"><span class="type-signature">(protected) </span>getUtcDateChanged<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 20:54:27 +08:00
<a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</li></ul></dd>
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line27">line 27</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 20:06:00 +08:00
</dl>
fix docs
2022-04-16 06:17:32 +08:00
<h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDeleted<span class="signature">(deleteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
API docs build
2023-09-06 15:25:00 +08:00
Mark the entity as (soft) deleted. It will be completely erased later.
This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
fix docs
2022-04-16 06:17:32 +08:00
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>deleteId</code></td>
<td class="type">
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 20:54:27 +08:00
<a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
fix docs
2022-04-16 06:17:32 +08:00
</li></ul></dd>
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line267">line 267</a>
API docs
2023-08-10 19:40:26 +08:00
</li></ul></dd>
</dl>
<h4 class="name" id="putEntityChange"><span class="type-signature">(protected) </span>putEntityChange<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractBeccaEntity.html#putEntityChange">AbstractBeccaEntity#putEntityChange</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line44">line 44</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
fix docs
2022-04-16 06:17:32 +08:00
</dl>
improvs
2022-12-30 06:12:38 +08:00
<h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
fix docs
2022-04-16 06:17:32 +08:00
<div class="description">
Saves entity - executes SQL, but doesn't commit the transaction on its own
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 20:54:27 +08:00
<a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
fix docs
2022-04-16 06:17:32 +08:00
</li></ul></dd>
update docs
2023-02-17 23:15:58 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
jsdocs
2023-10-08 01:57:53 +08:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line91">line 91</a>
update docs
2023-02-17 23:15:58 +08:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-11 04:30:54 +08:00
</dl>
fix docs
2022-04-16 06:17:32 +08:00
<h5>Returns:</h5>
fixed jsdoc script API generation, closes #2313
2021-11-11 04:30:54 +08:00
fix docs
2022-04-16 06:17:32 +08:00
<dl>
<dt>
Type
</dt>
<dd>
improvs
2022-12-30 06:12:38 +08:00
<span class="param-type">this</span>
fix docs
2022-04-16 06:17:32 +08:00
</dd>
</dl>
fixed jsdoc script API generation, closes #2313
2021-11-11 04:30:54 +08:00
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
fix docs
2022-04-16 06:17:32 +08:00
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
</article>
</section>
</div>
<nav>
Update API Docs
2023-08-21 16:17:16 +08:00
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
</nav>
<br class="clear">
<footer>
script api docs
2023-05-31 20:00:37 +08:00
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
added jsdocs generated pages
2018-08-30 02:44:35 +08:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in a new issue Copy permalink