Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-31 02:16:05 +01:00
Code Issues Packages Projects Releases Activity
Files
d09d3f5a9667268d9fa2fa0cfab7b734e5fd242b
Trilium/docs/backend_api/BEtapiToken.html

1669 lines
18 KiB
HTML
Raw Normal View History

updated API docs
2022-01-10 19:55:09 +01:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
docs updated
2023-01-03 13:54:27 +01:00
<title>JSDoc: Class: BEtapiToken</title>
updated API docs
2022-01-10 19:55:09 +01: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 13:54:27 +01:00
<h1 class="page-title">Class: BEtapiToken</h1>
updated API docs
2022-01-10 19:55:09 +01:00
<section>
<header>
docs updated
2023-01-03 13:54:27 +01:00
<h2><span class="attribs"><span class="type-signature"></span></span>BEtapiToken<span class="signature">()</span><span class="type-signature"></span></h2>
updated API docs
2022-01-10 19:55:09 +01:00
<div class="class-description">EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
Used by:
- Trilium Sender
forgotten note_types
2022-01-14 19:53:59 +01:00
- ETAPI clients
The format user is presented with is "<etapiTokenId>_<tokenHash>". This is also called "authToken" to distinguish it
from tokenHash and token.</div>
updated API docs
2022-01-10 19:55:09 +01:00
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
docs updated
2023-01-03 13:54:27 +01:00
<h4 class="name" id="BEtapiToken"><span class="type-signature"></span>new BEtapiToken<span class="signature">()</span><span class="type-signature"></span></h4>
updated API docs
2022-01-10 19:55:09 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line17">line 17</a>
</li></ul></dd>
updated API docs
2022-01-10 19:55:09 +01:00
</dl>
</div>
fix docs
2022-04-16 00:17:32 +02:00
<h3 class="subsection-title">Extends</h3>
<ul>
docs updated
2023-01-03 13:54:27 +01:00
<li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
fix docs
2022-04-16 00:17:32 +02:00
</ul>
updated API docs
2022-01-10 19:55:09 +01:00
<h3 class="subsection-title">Members</h3>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02: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 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02: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#line55">line 55</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</dl>
updated API docs
2022-01-10 19:55:09 +01:00
<h4 class="name" id="etapiTokenId"><span class="type-signature"></span>etapiTokenId<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 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line35">line 35</a>
</li></ul></dd>
updated API docs
2022-01-10 19:55:09 +01:00
</dl>
<h4 class="name" id="isDeleted"><span class="type-signature"></span>isDeleted<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 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line45">line 45</a>
</li></ul></dd>
updated API docs
2022-01-10 19:55:09 +01: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 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line37">line 37</a>
</li></ul></dd>
updated API docs
2022-01-10 19:55:09 +01:00
</dl>
<h4 class="name" id="tokenHash"><span class="type-signature"></span>tokenHash<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 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line39">line 39</a>
</li></ul></dd>
updated API docs
2022-01-10 19:55:09 +01:00
</dl>
<h4 class="name" id="utcDateCreated"><span class="type-signature"></span>utcDateCreated<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 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line41">line 41</a>
</li></ul></dd>
updated API docs
2022-01-10 19:55:09 +01: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 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line43">line 43</a>
</li></ul></dd>
fix docs
2022-04-16 00:17:32 +02:00
</dl>
<h3 class="subsection-title">Methods</h3>
API docs
2023-06-29 20:54:58 +02: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>
API docs
2023-08-10 13:40:26 +02: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#line246">line 246</a>
API docs
2023-06-29 20:54:58 +02: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>
<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#line124">line 124</a>
</li></ul></dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02: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 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02: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 16:15:58 +01:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</dl>
<h4 class="name" id="generateHash"><span class="type-signature">(protected) </span>generateHash<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 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02: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#line32">line 32</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</dl>
<h4 class="name" id="generateIdIfNecessary"><span class="type-signature">(protected) </span>generateIdIfNecessary<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 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02: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#line25">line 25</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02: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 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02: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#line76">line 76</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02: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 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02: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#line47">line 47</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</dl>
fix docs
2022-04-16 00:17:32 +02: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">
Mark the entity as (soft) deleted. It will be completely erased later.
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
API docs
2023-06-29 20:54:58 +02:00
This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
fix docs
2022-04-16 00:17:32 +02: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 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
fix docs
2022-04-16 00:17:32 +02:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-08-10 13:40:26 +02: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#line263">line 263</a>
</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>
<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#line64">line 64</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
updated API docs
2022-01-10 19:55:09 +01:00
</dl>
fix docs
2022-04-16 00:17:32 +02:00
updated API docs
2022-01-10 19:55:09 +01:00
fix docs
2022-04-16 00:17:32 +02:00
improvs
2022-12-29 23:12:38 +01: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 00:17:32 +02:00
updated API docs
2022-01-10 19:55:09 +01:00
fix docs
2022-04-16 00:17:32 +02: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 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
fix docs
2022-04-16 00:17:32 +02:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02: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#line85">line 85</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fix docs
2022-04-16 00:17:32 +02:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
improvs
2022-12-29 23:12:38 +01:00
<span class="param-type">this</span>
fix docs
2022-04-16 00:17:32 +02:00
</dd>
</dl>
updated API docs
2022-01-10 19:55:09 +01:00
</article>
</section>
</div>
<nav>
API docs
2023-06-29 20:54:58 +02: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>
updated API docs
2022-01-10 19:55:09 +01:00
</nav>
<br class="clear">
<footer>
script api docs
2023-05-31 14:00:37 +02:00
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
updated API docs
2022-01-10 19:55:09 +01:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue Copy Permalink