Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-10-29 11:44:21 +08:00
Code Issues Packages Projects Releases Wiki Activity
Notes/docs/frontend_api/FAttachment.html

1067 lines
11 KiB
HTML
Raw Normal View History

Update API Docs
2023-08-21 04:17:16 -04:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: FAttachment</title>
<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">
<h1 class="page-title">Class: FAttachment</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>FAttachment<span class="signature">()</span><span class="type-signature"></span></h2>
API docs build
2023-09-06 09:25:00 +02:00
<div class="class-description">Attachment is a file directly tied into a note without
being a hidden child.</div>
Update API Docs
2023-08-21 04:17:16 -04:00
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="FAttachment"><span class="type-signature"></span>new FAttachment<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line5">line 5</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="attachmentId"><span class="type-signature"></span>attachmentId<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h4 class="name" id="contentLength"><span class="type-signature"></span>contentLength<span class="type-signature"> :<a href="global.html#int">int</a></span></h4>
<div class="description">
optionally added to the entity
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#int">int</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dateModified"><span class="type-signature"></span>dateModified<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h4 class="name" id="froca"><span class="type-signature"></span>froca<span class="type-signature"> :Froca</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Froca</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
<h4 class="name" id="mime"><span class="type-signature"></span>mime<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ownerId"><span class="type-signature"></span>ownerId<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<h4 class="name" id="role"><span class="type-signature"></span>role<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
<h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line23">line 23</a>
</li></ul></dd>
</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">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
<h4 class="name" id="utcDateScheduledForErasureSince"><span class="type-signature"></span>utcDateScheduledForErasureSince<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line29">line 29</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getBlob"><span class="type-signature">(async) </span>getBlob<span class="signature">()</span><span class="type-signature"> &rarr; {FBlob}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">FBlob</span>
</dd>
</dl>
<h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_fattachment.js.html">entities/fattachment.js</a>, <a href="entities_fattachment.js.html#line41">line 41</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="FNote.html">FNote</a></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
API docs
2023-09-25 23:11:24 +02:00
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li><li><a href="global.html#getJsonContent">getJsonContent</a></li><li><a href="global.html#getJsonContentSafely">getJsonContentSafely</a></li></ul>
Update API Docs
2023-08-21 04:17:16 -04:00
</nav>
<br class="clear">
<footer>
chore(docs): update frontend docs
2024-12-15 10:44:40 +02:00
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a>
Update API Docs
2023-08-21 04:17:16 -04:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue Copy Permalink