docs: update docs
This commit is contained in:
StevanFreeborn authored and GitHub Actions committed
1 parent
2a67ead01a
commit
d99d00e450
71 files changed
+411
-414
No files matched your search
@@ -157,7 +157,7 @@
|
||||
--md-sys-color-surface-container-highest: #e3e2e6
|
||||
}
|
||||
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="FileInfo.html">FileInfo</a></li></ul><h1>Class FileInfo</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>FileInfo - Represents a file info.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/FileInfo.ts#L6">models/FileInfo.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="FileInfo.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in models/FileInfo.ts:6</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="FileInfo.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
||||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="FileInfo.html#contentType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>content<wbr/>Type</span></a>
|
||||
<a href="FileInfo.html#createdDate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created<wbr/>Date</span></a>
|
||||
<a href="FileInfo.html#fileHref" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Href</span></a>
|
||||
@@ -166,7 +166,7 @@
|
||||
<a href="FileInfo.html#notes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>notes</span></a>
|
||||
<a href="FileInfo.html#owner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a>
|
||||
<a href="FileInfo.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
||||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_FileInfo" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>File<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">contentType</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">createdDate</span>, <span class="tsd-kind-parameter">modifiedDate</span>, <span class="tsd-kind-parameter">owner</span>, <span class="tsd-kind-parameter">notes</span>, <span class="tsd-kind-parameter">fileHref</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><a href="#constructor.new_FileInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">contentType</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">createdDate</span>: <span class="tsd-signature-type">Date</span></span></li><li><span><span class="tsd-kind-parameter">modifiedDate</span>: <span class="tsd-signature-type">Date</span></span></li><li><span><span class="tsd-kind-parameter">owner</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">notes</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileHref</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/FileInfo.ts#L47">models/FileInfo.ts:47</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="contentType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>content<wbr/>Type</span><a href="#contentType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">content<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/FileInfo.ts#L15">models/FileInfo.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="createdDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>created<wbr/>Date</span><a href="#createdDate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">created<wbr/>Date</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/FileInfo.ts#L25">models/FileInfo.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileHref" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Href</span><a href="#fileHref" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">file<wbr/>Href</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90Line truncated
|
||||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_FileInfo" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>File<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">contentType</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">createdDate</span>, <span class="tsd-kind-parameter">modifiedDate</span>, <span class="tsd-kind-parameter">owner</span>, <span class="tsd-kind-parameter">notes</span>, <span class="tsd-kind-parameter">fileHref</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><a href="#constructor.new_FileInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">contentType</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">createdDate</span>: <span class="tsd-signature-type">Date</span></span></li><li><span><span class="tsd-kind-parameter">modifiedDate</span>: <span class="tsd-signature-type">Date</span></span></li><li><span><span class="tsd-kind-parameter">owner</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">notes</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileHref</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a></h4><aside class="tsd-sources"><ul><li>Defined in models/FileInfo.ts:47</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="contentType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>content<wbr/>Type</span><a href="#contentType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">content<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/FileInfo.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="createdDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>created<wbr/>Date</span><a href="#createdDate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">created<wbr/>Date</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/FileInfo.ts:25</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileHref" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Href</span><a href="#fileHref" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">file<wbr/>Href</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/FileInfo.ts:45</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="modifiedDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>modified<wbr/>Date</span><a href="#modifiedDate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">modified<wbr/>DaLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
Reference in new issue
Block a user