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="GetPagedRecordsResponse.html">GetPagedRecordsResponse</a></li></ul><h1>Class GetPagedRecordsResponse</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>GetPagedRecordsResponse - A response containing a paged collection of records.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#GetPagedRecordsResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="PagedResponse.html" class="tsd-signature-type tsd-kind-class">PagedResponse</a><span class="tsd-signature-symbol"><</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GetPagedRecordsResponse</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/GetPagedRecordsResponse.ts#L7">models/GetPagedRecordsResponse.ts:7</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="GetPagedRecordsResponse.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><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#GetPagedRecordsResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="PagedResponse.html" class="tsd-signature-type tsd-kind-class">PagedResponse</a><span class="tsd-signature-symbol"><</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GetPagedRecordsResponse</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/GetPagedRecordsResponse.ts:7</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="GetPagedRecordsResponse.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="GetPagedRecordsResponse.html#items" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>items</span></a>
|
||||
<a href="GetPagedRecordsResponse.html#pageNumber" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Number</span></a>
|
||||
<a href="GetPagedRecordsResponse.html#pageSize" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Size</span></a>
|
||||
@@ -171,7 +171,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a></h4><ul>
|
||||
<li>A new instance of the GetPagedRecordsResponse class.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/GetPagedRecordsResponse.ts#L17">models/GetPagedRecordsResponse.ts:17</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 tsd-is-inherited"><a id="items" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>items</span><a href="#items" 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">items</span><span class="tsd-signature-symbol">:</span> <a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#items">items</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/PagedResponse.ts#L8">models/PagedResponse.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="pageNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>page<wbr/>Number</span><a href="#pageNumber" 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">page<wbr/>Number</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#pageNumber">pageNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/PagedResponse.ts#L13">models/PagedResponse.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="pageSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>page<wbr/>Size</span><a href="#pageSize" 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">page<wbr/>Size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#pageSize">pageSize</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/PagedResponse.ts#L18">models/PagedResponse.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="totalPages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total<wbr/>Pages</span><a href="#totalPages" 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">total<wbr/>Pages</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#totalPages">totalPages</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/PagedResponse.ts#L23">models/PagedResponse.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="totalRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total<wbr/>Records</span><a href="#totalRecords" 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">total<wbr/>Records</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#totalRecords">totalRecords</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/PagedResponse.ts#L28">models/PagedResponse.ts:28</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div cLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#constructor">constructor</a></p><ul><li>Defined in models/GetPagedRecordsResponse.ts:17</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="items" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>items</span><a href="#items" 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">items</span><span class="tsd-signature-symbol">:</span> <a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#items">items</a></p><ul><li>Defined in models/PagedResponse.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="pageNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>page<wbr/>Number</span><a href="#pageNumber" 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">page<wbr/>Number</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#pageNumber">pageNumber</a></p><ul><li>Defined in models/PagedResponse.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="pageSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>page<wbr/>Size</span><a href="#pageSize" 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">page<wbr/>Size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#pageSize">pageSize</a></p><ul><li>Defined in models/PagedResponse.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="totalPages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total<wbr/>Pages</span><a href="#totalPages" 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">total<wbr/>Pages</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#totalPages">totalPages</a></p><ul><li>Defined in models/PagedResponse.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="totalRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total<wbr/>Records</span><a href="#totalRecords" 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">total<wbr/>Records</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="PagedResponse.html">PagedResponse</a>.<a href="PagedResponse.html#totalRecords">totalRecords</a></p><ul><li>Defined in models/PagedResponse.ts:28</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d=Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
Reference in new issue
Block a user