docs: update docs
This commit is contained in:
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="ApiResponse.html">ApiResponse</a></li></ul><h1>Class ApiResponse<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ApiResponse - A generic response object for API requests.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></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/ApiResponse.ts#L53">models/ApiResponse.ts:53</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="ApiResponse.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"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:53</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="ApiResponse.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="ApiResponse.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a>
|
||||
<a href="ApiResponse.html#isSuccessful" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Successful</span></a>
|
||||
<a href="ApiResponse.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
|
||||
@@ -191,91 +191,91 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#constructor.new_ApiResponse.T-1">T</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A new instance of the ApiResponse class.</li>
|
||||
</ul>
|
||||
<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/ApiResponse.ts#L81">models/ApiResponse.ts:81</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="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" 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">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#constructor.new_ApiResponse.T-1">T</a></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/ApiResponse.ts#L72">models/ApiResponse.ts:72</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isSuccessful" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Successful</span><a href="#isSuccessful" 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">is<wbr/>Successful</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/ApiResponse.ts#L62">models/ApiResponse.ts:62</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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">message</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/ApiResponse.ts#L67">models/ApiResponse.ts:67</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="statusCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status<wbr/>Code</span><a href="#statusCode" 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">status<wbr/>Code</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L57">models/ApiResponse.ts:57</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="asAppCollectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>App<wbr/>Collection<wbr/>Type</span><a href="#asAppCollectionType" 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="asAppCollectionType.asAppCollectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>App<wbr/>Collection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#asAppCollectionType.asAppCollectionType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a hrefLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:81</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="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" 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">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#constructor.new_ApiResponse.T-1">T</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:72</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isSuccessful" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Successful</span><a href="#isSuccessful" 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">is<wbr/>Successful</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:62</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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">message</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/ApiResponse.ts:67</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="statusCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status<wbr/>Code</span><a href="#statusCode" 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">status<wbr/>Code</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"><ul><li>Defined in models/ApiResponse.ts:57</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="asAppCollectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>App<wbr/>Collection<wbr/>Type</span><a href="#asAppCollectionType" 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="asAppCollectionType.asAppCollectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>App<wbr/>Collection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#asAppCollectionType.asAppCollectionType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<CollectionResponse<App>>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAppCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse<App>>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L138">models/ApiResponse.ts:138</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asAppType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>App<wbr/>Type</span><a href="#asAppType" 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="asAppType.asAppType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>App<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><a href="#asAppType.asAppType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:138</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asAppType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>App<wbr/>Type</span><a href="#asAppType" 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="asAppType.asAppType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>App<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><a href="#asAppType.asAppType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<App>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAppType - Converts the ApiResponse to an ApiResponse<App>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L118">models/ApiResponse.ts:118</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asCreatedWithIdResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response<wbr/>Type</span><a href="#asCreatedWithIdResponseType" 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="asCreatedWithIdResponseType.asCreatedWithIdResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:118</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asCreatedWithIdResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response<wbr/>Type</span><a href="#asCreatedWithIdResponseType" 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="asCreatedWithIdResponseType.asCreatedWithIdResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<CreatedWithIdResponse<T>>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asCreatedWithIdResponseType - Converts the ApiResponse to an ApiResponse<CreatedWithIdResponse<T>>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L225">models/ApiResponse.ts:225</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFieldCollectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Field<wbr/>Collection<wbr/>Type</span><a href="#asFieldCollectionType" 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="asFieldCollectionType.asFieldCollectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Field<wbr/>Collection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#asFieldCollectionType.asFieldCollectionType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:225</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFieldCollectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Field<wbr/>Collection<wbr/>Type</span><a href="#asFieldCollectionType" 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="asFieldCollectionType.asFieldCollectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Field<wbr/>Collection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#asFieldCollectionType.asFieldCollectionType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<CollectionResponse<Field>>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asFieldCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse<Field>>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L176">models/ApiResponse.ts:176</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFieldType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Field<wbr/>Type</span><a href="#asFieldType" 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="asFieldType.asFieldType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Field<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><a href="#asFieldType.asFieldType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:176</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFieldType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Field<wbr/>Type</span><a href="#asFieldType" 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="asFieldType.asFieldType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Field<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><a href="#asFieldType.asFieldType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<Field>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asFieldType - Converts the ApiResponse to an ApiResponse<Field>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L161">models/ApiResponse.ts:161</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFileInfoType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>File<wbr/>Info<wbr/>Type</span><a href="#asFileInfoType" 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="asFileInfoType.asFileInfoType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>File<wbr/>Info<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">></span><a href="#asFileInfoType.asFileInfoType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:161</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFileInfoType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>File<wbr/>Info<wbr/>Type</span><a href="#asFileInfoType" 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="asFileInfoType.asFileInfoType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>File<wbr/>Info<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">></span><a href="#asFileInfoType.asFileInfoType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<FileInfo>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asFileInfoType - Converts the ApiResponse to an ApiResponse<FileInfo>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L245">models/ApiResponse.ts:245</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFileType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>File<wbr/>Type</span><a href="#asFileType" 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="asFileType.asFileType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>File<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">></span><a href="#asFileType.asFileType-1" 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">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:245</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFileType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>File<wbr/>Type</span><a href="#asFileType" 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="asFileType.asFileType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>File<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">></span><a href="#asFileType.asFileType-1" 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">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<File>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asFileType - Converts the ApiResponse to an ApiResponse<File>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L270">models/ApiResponse.ts:270</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedAppsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Apps<wbr/>Response<wbr/>Type</span><a href="#asGetPagedAppsResponseType" 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="asGetPagedAppsResponseType.asGetPagedAppsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Apps<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">></span><a href="#asGetPagedAppsResponseType.asGetPagedAppsResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:270</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedAppsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Apps<wbr/>Response<wbr/>Type</span><a href="#asGetPagedAppsResponseType" 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="asGetPagedAppsResponseType.asGetPagedAppsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Apps<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">></span><a href="#asGetPagedAppsResponseType.asGetPagedAppsResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<GetPagedAppsResponse>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asGetPagedAppsResponseType - Converts the ApiResponse to an ApiResponse<GetPagedAppsResponse>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L92">models/ApiResponse.ts:92</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedFieldsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Fields<wbr/>Response<wbr/>Type</span><a href="#asGetPagedFieldsResponseType" 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="asGetPagedFieldsResponseType.asGetPagedFieldsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Fields<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">></span><a href="#asGetPagedFieldsResponseType.asGetPagedFieldsResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:92</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedFieldsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Fields<wbr/>Response<wbr/>Type</span><a href="#asGetPagedFieldsResponseType" 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="asGetPagedFieldsResponseType.asGetPagedFieldsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Fields<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">></span><a href="#asGetPagedFieldsResponseType.asGetPagedFieldsResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<GetPagedFieldsResponse>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asGetPagedFieldsResponseType - Converts the ApiResponse to an ApiResponse<GetPagedFieldsResponse>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L199">models/ApiResponse.ts:199</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedRecordsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Records<wbr/>Response<wbr/>Type</span><a href="#asGetPagedRecordsResponseType" 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="asGetPagedRecordsResponseType.asGetPagedRecordsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Records<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><a href="#asGetPagedRecordsResponseType.asGetPagedRecordsResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:199</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedRecordsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Records<wbr/>Response<wbr/>Type</span><a href="#asGetPagedRecordsResponseType" 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="asGetPagedRecordsResponseType.asGetPagedRecordsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Records<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><a href="#asGetPagedRecordsResponseType.asGetPagedRecordsResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<GetPagedRecordsResponse>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asGetPagedRecordsResponseType - Converts the ApiResponse to an ApiResponse<GetPagedRecordsResponse>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L368">models/ApiResponse.ts:368</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedReportsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Reports<wbr/>Response<wbr/>Type</span><a href="#asGetPagedReportsResponseType" 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="asGetPagedReportsResponseType.asGetPagedReportsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Reports<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">></span><a href="#asGetPagedReportsResponseType.asGetPagedReportsResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:368</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedReportsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Reports<wbr/>Response<wbr/>Type</span><a href="#asGetPagedReportsResponseType" 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="asGetPagedReportsResponseType.asGetPagedReportsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Reports<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">></span><a href="#asGetPagedReportsResponseType.asGetPagedReportsResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<GetPagedReportsResponse>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asGetPagedReportsResponseType - Converts the ApiResponse to an ApiResponse<GetPagedReportsResponse>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L322">models/ApiResponse.ts:322</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asListItemResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>List<wbr/>Item<wbr/>Response<wbr/>Type</span><a href="#asListItemResponseType" 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="asListItemResponseType.asListItemResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>List<wbr/>Item<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">></span><a href="#asListItemResponseType.asListItemResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:322</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asListItemResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>List<wbr/>Item<wbr/>Response<wbr/>Type</span><a href="#asListItemResponseType" 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="asListItemResponseType.asListItemResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>List<wbr/>Item<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">></span><a href="#asListItemResponseType.asListItemResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<ListItemResponse>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asListItemResponseType - Converts the ApiResponse to an ApiResponse<ListItemResponse>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L306">models/ApiResponse.ts:306</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asRecordCollectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Record<wbr/>Collection<wbr/>Type</span><a href="#asRecordCollectionType" 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="asRecordCollectionType.asRecordCollectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Record<wbr/>Collection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</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><span class="tsd-signature-symbol">></span><a href="#asRecordCollectionType.asRecordCollectionType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</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><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:306</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asRecordCollectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Record<wbr/>Collection<wbr/>Type</span><a href="#asRecordCollectionType" 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="asRecordCollectionType.asRecordCollectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Record<wbr/>Collection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</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><span class="tsd-signature-symbol">></span><a href="#asRecordCollectionType.asRecordCollectionType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</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><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<CollectionResponse<Record>>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asRecordCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse<Record>>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L423">models/ApiResponse.ts:423</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asRecordType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Record<wbr/>Type</span><a href="#asRecordType" 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="asRecordType.asRecordType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Record<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</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><a href="#asRecordType.asRecordType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</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></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:423</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asRecordType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Record<wbr/>Type</span><a href="#asRecordType" 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="asRecordType.asRecordType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Record<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</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><a href="#asRecordType.asRecordType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</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></h4><ul>
|
||||
<li>An ApiResponse<Record>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asRecordType - Converts the ApiResponse to an ApiResponse<Record>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L398">models/ApiResponse.ts:398</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asReportDataType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Report<wbr/>Data<wbr/>Type</span><a href="#asReportDataType" 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="asReportDataType.asReportDataType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Report<wbr/>Data<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">></span><a href="#asReportDataType.asReportDataType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:398</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asReportDataType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Report<wbr/>Data<wbr/>Type</span><a href="#asReportDataType" 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="asReportDataType.asReportDataType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Report<wbr/>Data<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">></span><a href="#asReportDataType.asReportDataType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<ReportData>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asReportDataType - Converts the ApiResponse to an ApiResponse<ReportData>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L348">models/ApiResponse.ts:348</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asSaveRecordResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Save<wbr/>Record<wbr/>Response<wbr/>Type</span><a href="#asSaveRecordResponseType" 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="asSaveRecordResponseType.asSaveRecordResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Save<wbr/>Record<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">></span><a href="#asSaveRecordResponseType.asSaveRecordResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:348</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asSaveRecordResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Save<wbr/>Record<wbr/>Response<wbr/>Type</span><a href="#asSaveRecordResponseType" 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="asSaveRecordResponseType.asSaveRecordResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Save<wbr/>Record<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">></span><a href="#asSaveRecordResponseType.asSaveRecordResponseType-1" 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"><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>An ApiResponse<SaveRecordResponse>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asSaveRecordResponseType - Converts the ApiResponse to an ApiResponse<SaveRecordResponse>.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L450">models/ApiResponse.ts:450</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToAttachment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Attachment</span><a href="#convertToAttachment" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="convertToAttachment.convertToAttachment-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Attachment</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attachmentItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><a href="#convertToAttachment.convertToAttachment-1" 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">attachmentItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The attachment item to convert.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:450</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToAttachment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Attachment</span><a href="#convertToAttachment" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="convertToAttachment.convertToAttachment-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Attachment</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attachmentItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><a href="#convertToAttachment.convertToAttachment-1" 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">attachmentItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The attachment item to convert.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a></h4><ul>
|
||||
<li>The converted attachment object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToAttachment - Converts the attachment item to the appropriate attachment object.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L706">models/ApiResponse.ts:706</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToDelegate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Delegate</span><a href="#convertToDelegate" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="convertToDelegate.convertToDelegate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Delegate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">delegateItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><a href="#convertToDelegate.convertToDelegate-1" 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">delegateItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The delegate item to convert.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:706</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToDelegate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Delegate</span><a href="#convertToDelegate" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="convertToDelegate.convertToDelegate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Delegate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">delegateItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><a href="#convertToDelegate.convertToDelegate-1" 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">delegateItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The delegate item to convert.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a></h4><ul>
|
||||
<li>The converted Delegate object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToDelegate - Converts the delegate item to a Delegate object.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L655">models/ApiResponse.ts:655</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToScoringGroup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Scoring<wbr/>Group</span><a href="#convertToScoringGroup" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="convertToScoringGroup.convertToScoringGroup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Scoring<wbr/>Group</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scoringGroupItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><a href="#convertToScoringGroup.convertToScoringGroup-1" 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">scoringGroupItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The scoring group item to convert.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:655</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToScoringGroup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Scoring<wbr/>Group</span><a href="#convertToScoringGroup" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="convertToScoringGroup.convertToScoringGroup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Scoring<wbr/>Group</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scoringGroupItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><a href="#convertToScoringGroup.convertToScoringGroup-1" 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">scoringGroupItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The scoring group item to convert.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a></h4><ul>
|
||||
<li>The converted scoring group object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToScoringGroup - Converts the scoring group item to the appropriate scoring group object.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L692">models/ApiResponse.ts:692</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#convertToTimeSpanData" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="convertToTimeSpanData.convertToTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timeSpanItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#convertToTimeSpanData.convertToTimeSpanData-1" 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">timeSpanItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The time span item to convert.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:692</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#convertToTimeSpanData" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="convertToTimeSpanData.convertToTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timeSpanItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#convertToTimeSpanData.convertToTimeSpanData-1" 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">timeSpanItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The time span item to convert.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The converted time span data object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToTimeSpanData - Converts the time span item to the appropriate time span data object.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L735">models/ApiResponse.ts:735</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getFieldByType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Field<wbr/>By<wbr/>Type</span><a href="#getFieldByType" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getFieldByType.getFieldByType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Field<wbr/>By<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><a href="#getFieldByType.getFieldByType-1" 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">fieldItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The field item to convert.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:735</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getFieldByType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Field<wbr/>By<wbr/>Type</span><a href="#getFieldByType" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getFieldByType.getFieldByType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Field<wbr/>By<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><a href="#getFieldByType.getFieldByType-1" 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">fieldItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The field item to convert.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a></h4><ul>
|
||||
<li>The converted field object.</li>
|
||||
</ul>
|
||||
@@ -283,17 +283,17 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the field item's type is unknown.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L579">models/ApiResponse.ts:579</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getListValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>List<wbr/>Values</span><a href="#getListValues" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getListValues.getListValues-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>List<wbr/>Values</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ListValue.html" class="tsd-signature-type tsd-kind-class">ListValue</a><span class="tsd-signature-symbol">[]</span><a href="#getListValues.getListValues-1" 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">fieldItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The field item whose values should be converted.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:579</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getListValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>List<wbr/>Values</span><a href="#getListValues" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getListValues.getListValues-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>List<wbr/>Values</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ListValue.html" class="tsd-signature-type tsd-kind-class">ListValue</a><span class="tsd-signature-symbol">[]</span><a href="#getListValues.getListValues-1" 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">fieldItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The field item whose values should be converted.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ListValue.html" class="tsd-signature-type tsd-kind-class">ListValue</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The converted list values.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getListValues - Converts the field items list values to a ListValue[].</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L786">models/ApiResponse.ts:786</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getRecordValueByType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Record<wbr/>Value<wbr/>By<wbr/>Type</span><a href="#getRecordValueByType" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getRecordValueByType.getRecordValueByType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Record<wbr/>Value<wbr/>By<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordValueItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getRecordValueByType.getRecordValueByType-1" 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">recordValueItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The record value item.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:786</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getRecordValueByType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Record<wbr/>Value<wbr/>By<wbr/>Type</span><a href="#getRecordValueByType" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getRecordValueByType.getRecordValueByType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Record<wbr/>Value<wbr/>By<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordValueItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getRecordValueByType.getRecordValueByType-1" 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">recordValueItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The record value item.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>The RecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordValueByType - Gets the RecordValue by by type.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ApiResponse.ts#L468">models/ApiResponse.ts:468</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#isSuccessful" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Successful</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#statusCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status<wbr/>Code</span></a><a href="#asAppCollectionType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>App<wbr/>Collection<wbr/>Type</span></a><a href="#asAppType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>App<wbr/>Type</span></a><a href="#asCreatedWithIdResponseType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response<wbr/>Type</span></a><a href="#asFieldCollectionType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Field<wbr/>Collection<wbr/>Type</span></a><a href="#asFieldType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Field<wbr/>Type</span></a><a href="#asFileInfoType" cLine truncated
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:468</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#isSuccessful" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Successful</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#statusCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status<wbr/>Code</span></a><a href="#asAppCollectionType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>App<wbr/>Collection<wbr/>Type</span></a><a href="#asAppType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>App<wbr/>Type</span></a><a href="#asCreatedWithIdResponseType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response<wbr/>Type</span></a><a href="#asFieldCollectionType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Field<wbr/>Collection<wbr/>Type</span></a><a href="#asFieldType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Field<wbr/>Type</span></a><a href="#asFileInfoType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="App.html">App</a></li></ul><h1>Class App</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>App - Model for the App object</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/App.ts#L4">models/App.ts:4</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="App.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/App.ts:4</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="App.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="App.html#href" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>href</span></a>
|
||||
<a href="App.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
||||
<a href="App.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
|
||||
@@ -167,7 +167,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="App.html" class="tsd-signature-type tsd-kind-class">App</a></h4><ul>
|
||||
<li>A new instance of the App class.</li>
|
||||
</ul>
|
||||
<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/App.ts#L27">models/App.ts:27</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="href" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>href</span><a href="#href" 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">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/90a559a/src/models/App.ts#L8">models/App.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/App.ts#L13">models/App.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/App.ts#L18">models/App.ts:18</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</Line truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/App.ts:27</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="href" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>href</span><a href="#href" 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">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/App.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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"><ul><li>Defined in models/App.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/App.ts:18</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="Attachment.html">Attachment</a></li></ul><h1>Class Attachment</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Attachment - Represents an attachment.</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/Attachment.ts#L6">models/Attachment.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="Attachment.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/Attachment.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="Attachment.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="Attachment.html#fileId" 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/>Id</span></a>
|
||||
<a href="Attachment.html#fileName" 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/>Name</span></a>
|
||||
<a href="Attachment.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>
|
||||
@@ -169,7 +169,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a></h4><ul>
|
||||
<li>A new instance of Attachment.</li>
|
||||
</ul>
|
||||
<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/Attachment.ts#L35">models/Attachment.ts:35</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="fileId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Id</span><a href="#fileId" 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/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Attachment.ts#L10">models/Attachment.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Name</span><a href="#fileName" 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/>Name</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/Attachment.ts#L15">models/Attachment.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="notes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>notes</span><a href="#notes" 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">notes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/Attachment.ts#L20">models/Attachment.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="storageLocation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>storage<wbr/>Location</span><a href="#storageLocation" 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">storage<wbr/>Location</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FileStorageSite.html" class="tsd-signature-type tsd-kind-enum">FileStorageSite</a></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/Attachment.ts#L25">models/Attachment.ts:25</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg widLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Attachment.ts:35</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="fileId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Id</span><a href="#fileId" 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/>Id</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"><ul><li>Defined in models/Attachment.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Name</span><a href="#fileName" 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/>Name</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/Attachment.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="notes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>notes</span><a href="#notes" 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">notes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/Attachment.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="storageLocation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>storage<wbr/>Location</span><a href="#storageLocation" 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">storage<wbr/>Location</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FileStorageSite.html" class="tsd-signature-type tsd-kind-enum">FileStorageSite</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Attachment.ts:25</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background"Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="AttachmentListRecordValue.html">AttachmentListRecordValue</a></li></ul><h1>Class AttachmentListRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>AttachmentListRecordValue - A record value represented by a list of attachments.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#AttachmentListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">AttachmentListRecordValue</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/AttachmentListRecordValue.ts#L8">models/AttachmentListRecordValue.ts:8</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="AttachmentListRecordValue.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#AttachmentListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">AttachmentListRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/AttachmentListRecordValue.ts:8</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="AttachmentListRecordValue.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="AttachmentListRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="AttachmentListRecordValue.html#type" 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>type</span></a>
|
||||
<a href="AttachmentListRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="AttachmentListRecordValue.html" class="tsd-signature-type tsd-kind-class">AttachmentListRecordValue</a></h4><ul>
|
||||
<li>A new instance of AttachmentListRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/AttachmentListRecordValue.ts#L15">models/AttachmentListRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/AttachmentListRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="CollectionResponse.html">CollectionResponse</a></li></ul><h1>Class CollectionResponse<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>CollectionResponse - A generic object for responses that contain collections of objects.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></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/CollectionResponse.ts#L4">models/CollectionResponse.ts:4</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="CollectionResponse.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"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in models/CollectionResponse.ts:4</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="CollectionResponse.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="CollectionResponse.html#count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count</span></a>
|
||||
<a href="CollectionResponse.html#items" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>items</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_CollectionResponse" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Collection<wbr/>Response</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CollectionResponse.html#constructor.new_CollectionResponse.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">count</span>, <span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CollectionResponse.html#constructor.new_CollectionResponse.T-1">T</a><span class="tsd-signature-symbol">></span><a href="#constructor.new_CollectionResponse" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructor.new_CollectionResponse.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">count</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The total count of items in the collection.</p>
|
||||
@@ -165,7 +165,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CollectionResponse.html#constructor.new_CollectionResponse.T-1">T</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A new instance of the CollectionResponse.</li>
|
||||
</ul>
|
||||
<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/CollectionResponse.ts#L21">models/CollectionResponse.ts:21</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="count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>count</span><a href="#count" 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">count</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/CollectionResponse.ts#L8">models/CollectionResponse.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><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 class="tsd-signature-type tsd-kind-type-parameter" href="CollectionResponse.html#constructor.new_CollectionResponse.T-1">T</a><span class="tsd-signature-symbol">[]</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/CollectionResponse.ts#L13">models/CollectionResponse.ts:13</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use hrLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/CollectionResponse.ts:21</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="count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>count</span><a href="#count" 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">count</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"><ul><li>Defined in models/CollectionResponse.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member"><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 class="tsd-signature-type tsd-kind-type-parameter" href="CollectionResponse.html#constructor.new_CollectionResponse.T-1">T</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/CollectionResponse.ts:13</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count</span></a><a href="#items" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>items</span></a></divLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -157,13 +157,13 @@
|
||||
--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="CreatedWithIdResponse.html">CreatedWithIdResponse</a></li></ul><h1>Class CreatedWithIdResponse<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>CreatedWithIdResponse<T> - Represents a response to a request to create a resource.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#CreatedWithIdResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">CreatedWithIdResponse</span><ul class="tsd-hierarchy"><li><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a></li><li><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a></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/CreatedWithIdResponse.ts#L4">models/CreatedWithIdResponse.ts:4</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="CreatedWithIdResponse.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"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#CreatedWithIdResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">CreatedWithIdResponse</span><ul class="tsd-hierarchy"><li><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a></li><li><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/CreatedWithIdResponse.ts:4</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="CreatedWithIdResponse.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="CreatedWithIdResponse.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</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_CreatedWithIdResponse" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a><span class="tsd-signature-symbol">></span><a href="#constructor.new_CreatedWithIdResponse" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructor.new_CreatedWithIdResponse.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The id of the created object.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A new instance of the CreatedWithIdResponse class.</li>
|
||||
</ul>
|
||||
<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/CreatedWithIdResponse.ts#L15">models/CreatedWithIdResponse.ts:15</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="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a></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/CreatedWithIdResponse.ts#L8">models/CreatedWithIdResponse.ts:8</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/CreatedWithIdResponse.ts:15</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="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/CreatedWithIdResponse.ts:8</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="DateRecordValue.html">DateRecordValue</a></li></ul><h1>Class DateRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>DateRecordValue - A value for a date field in a record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#DateRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">DateRecordValue</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/DateRecordValue.ts#L7">models/DateRecordValue.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="DateRecordValue.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#DateRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">DateRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/DateRecordValue.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="DateRecordValue.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="DateRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="DateRecordValue.html#type" 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>type</span></a>
|
||||
<a href="DateRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="DateRecordValue.html" class="tsd-signature-type tsd-kind-class">DateRecordValue</a></h4><ul>
|
||||
<li>A new instance of DateRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/DateRecordValue.ts#L14">models/DateRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/DateRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="DecimalRecordValue.html">DecimalRecordValue</a></li></ul><h1>Class DecimalRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>DecimalRecordValue - Represents a decimal record value</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#DecimalRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">DecimalRecordValue</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/DecimalRecordValue.ts#L7">models/DecimalRecordValue.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="DecimalRecordValue.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#DecimalRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">DecimalRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/DecimalRecordValue.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="DecimalRecordValue.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="DecimalRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="DecimalRecordValue.html#type" 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>type</span></a>
|
||||
<a href="DecimalRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="DecimalRecordValue.html" class="tsd-signature-type tsd-kind-class">DecimalRecordValue</a></h4><ul>
|
||||
<li>A new instance of DecimalRecordValue</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/DecimalRecordValue.ts#L14">models/DecimalRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/DecimalRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="Delegate.html">Delegate</a></li></ul><h1>Class Delegate</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Delegate - Represents a delegate.</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/Delegate.ts#L6">models/Delegate.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="Delegate.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/Delegate.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="Delegate.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="Delegate.html#delegateType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delegate<wbr/>Type</span></a>
|
||||
<a href="Delegate.html#delegationCompletedDateTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delegation<wbr/>Completed<wbr/>Date<wbr/>Time</span></a>
|
||||
<a href="Delegate.html#delegationDateTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delegation<wbr/>Date<wbr/>Time</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="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a></h4><ul>
|
||||
<li>A new instance of Delegate.</li>
|
||||
</ul>
|
||||
<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/Delegate.ts#L41">models/Delegate.ts:41</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="delegateType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delegate<wbr/>Type</span><a href="#delegateType" 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">delegate<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DelegateType.html" class="tsd-signature-type tsd-kind-enum">DelegateType</a></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/Delegate.ts#L10">models/Delegate.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="delegationCompletedDateTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delegation<wbr/>Completed<wbr/>Date<wbr/>Time</span><a href="#delegationCompletedDateTime" 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">delegation<wbr/>Completed<wbr/>Date<wbr/>Time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/Delegate.ts#L30">models/Delegate.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="delegationDateTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delegation<wbr/>Date<wbr/>Time</span><a href="#delegationDateTime" 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">delegation<wbr/>Date<wbr/>Time</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/Delegate.ts#L25">models/Delegate.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="emailAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>email<wbr/>Address</span><a href="#emailAddress" 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">email<wbr/>Address</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/Delegate.ts#L20">models/Delegate.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/Delegate.ts#L15">models/Delegate.ts:15</a></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=Line truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Delegate.ts:41</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="delegateType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delegate<wbr/>Type</span><a href="#delegateType" 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">delegate<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DelegateType.html" class="tsd-signature-type tsd-kind-enum">DelegateType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Delegate.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="delegationCompletedDateTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delegation<wbr/>Completed<wbr/>Date<wbr/>Time</span><a href="#delegationCompletedDateTime" 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">delegation<wbr/>Completed<wbr/>Date<wbr/>Time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/Delegate.ts:30</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="delegationDateTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delegation<wbr/>Date<wbr/>Time</span><a href="#delegationDateTime" 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">delegation<wbr/>Date<wbr/>Time</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/Delegate.ts:25</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="emailAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>email<wbr/>Address</span><a href="#emailAddress" 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">email<wbr/>Address</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/Delegate.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/Delegate.ts:15</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="noneLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="DelegateListRecordValue.html">DelegateListRecordValue</a></li></ul><h1>Class DelegateListRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>DelegateListRecordValue - Represents a delegate list record value.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#DelegateListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">DelegateListRecordValue</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/DelegateListRecordValue.ts#L8">models/DelegateListRecordValue.ts:8</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="DelegateListRecordValue.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#DelegateListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">DelegateListRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/DelegateListRecordValue.ts:8</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="DelegateListRecordValue.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="DelegateListRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="DelegateListRecordValue.html#type" 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>type</span></a>
|
||||
<a href="DelegateListRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="DelegateListRecordValue.html" class="tsd-signature-type tsd-kind-class">DelegateListRecordValue</a></h4><ul>
|
||||
<li>A new instance of DelegateListRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/DelegateListRecordValue.ts#L15">models/DelegateListRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/DelegateListRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="EndpointFactory.html">EndpointFactory</a></li></ul><h1>Class EndpointFactory</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>EndpointFactory - A factory class for creating endpoints.</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/EndpointFactory.ts#L4">models/EndpointFactory.ts:4</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="EndpointFactory.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/EndpointFactory.ts:4</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="EndpointFactory.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">Methods</h3><div class="tsd-index-list"><a href="EndpointFactory.html#getAddOrUpdateListItemEndpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item<wbr/>Endpoint</span></a>
|
||||
<a href="EndpointFactory.html#getAddOrUpdateRecordEndpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>Record<wbr/>Endpoint</span></a>
|
||||
<a href="EndpointFactory.html#getAppByIdEndpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>App<wbr/>By<wbr/>Id<wbr/>Endpoint</span></a>
|
||||
@@ -185,112 +185,112 @@
|
||||
<li>The add or update list item endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getAddOrUpdateListItemEndpoint - Gets the add or update list item endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L122">models/EndpointFactory.ts:122</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddOrUpdateRecordEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>Record<wbr/>Endpoint</span><a href="#getAddOrUpdateRecordEndpoint" 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="getAddOrUpdateRecordEndpoint.getAddOrUpdateRecordEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>Record<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAddOrUpdateRecordEndpoint.getAddOrUpdateRecordEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:122</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddOrUpdateRecordEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>Record<wbr/>Endpoint</span><a href="#getAddOrUpdateRecordEndpoint" 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="getAddOrUpdateRecordEndpoint.getAddOrUpdateRecordEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>Record<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAddOrUpdateRecordEndpoint.getAddOrUpdateRecordEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The add or update record endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getAddOrUpdateRecordEndpoint - Gets the add or update record endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L191">models/EndpointFactory.ts:191</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>App<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getAppByIdEndpoint" 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="getAppByIdEndpoint.getAppByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>App<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAppByIdEndpoint.getAppByIdEndpoint-1" 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">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:191</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>App<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getAppByIdEndpoint" 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="getAppByIdEndpoint.getAppByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>App<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAppByIdEndpoint.getAppByIdEndpoint-1" 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">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The app by id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getAppByIdEndpoint - Gets the app by id endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L26">models/EndpointFactory.ts:26</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppsByIdsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Apps<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><a href="#getAppsByIdsEndpoint" 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="getAppsByIdsEndpoint.getAppsByIdsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAppsByIdsEndpoint.getAppsByIdsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:26</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppsByIdsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Apps<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><a href="#getAppsByIdsEndpoint" 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="getAppsByIdsEndpoint.getAppsByIdsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAppsByIdsEndpoint.getAppsByIdsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The apps by ids endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getAppsByIdsEndpoint - Gets the apps by ids endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L34">models/EndpointFactory.ts:34</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Apps<wbr/>Endpoint</span><a href="#getAppsEndpoint" 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="getAppsEndpoint.getAppsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAppsEndpoint.getAppsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:34</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Apps<wbr/>Endpoint</span><a href="#getAppsEndpoint" 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="getAppsEndpoint.getAppsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAppsEndpoint.getAppsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The apps endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getAppsEndpoint - Gets the apps endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L17">models/EndpointFactory.ts:17</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDeleteFileByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Delete<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getDeleteFileByIdEndpoint" 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="getDeleteFileByIdEndpoint.getDeleteFileByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Delete<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDeleteFileByIdEndpoint.getDeleteFileByIdEndpoint-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:17</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDeleteFileByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Delete<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getDeleteFileByIdEndpoint" 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="getDeleteFileByIdEndpoint.getDeleteFileByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Delete<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDeleteFileByIdEndpoint.getDeleteFileByIdEndpoint-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the file.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The delete file by id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getDeleteFileByIdEndpoint - Gets the delete file by id endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L86">models/EndpointFactory.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDeleteListItemEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Delete<wbr/>List<wbr/>Item<wbr/>Endpoint</span><a href="#getDeleteListItemEndpoint" 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="getDeleteListItemEndpoint.getDeleteListItemEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Delete<wbr/>List<wbr/>Item<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listId</span>, <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDeleteListItemEndpoint.getDeleteListItemEndpoint-1" 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">listId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the list.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:86</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDeleteListItemEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Delete<wbr/>List<wbr/>Item<wbr/>Endpoint</span><a href="#getDeleteListItemEndpoint" 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="getDeleteListItemEndpoint.getDeleteListItemEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Delete<wbr/>List<wbr/>Item<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listId</span>, <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDeleteListItemEndpoint.getDeleteListItemEndpoint-1" 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">listId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the list.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">itemId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the list item.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The delete list item endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getDeleteListItemEndpoint - Gets the delete list item endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L132">models/EndpointFactory.ts:132</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDeleteRecordByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Delete<wbr/>Record<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getDeleteRecordByIdEndpoint" 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="getDeleteRecordByIdEndpoint.getDeleteRecordByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Delete<wbr/>Record<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDeleteRecordByIdEndpoint.getDeleteRecordByIdEndpoint-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:132</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDeleteRecordByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Delete<wbr/>Record<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getDeleteRecordByIdEndpoint" 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="getDeleteRecordByIdEndpoint.getDeleteRecordByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Delete<wbr/>Record<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDeleteRecordByIdEndpoint.getDeleteRecordByIdEndpoint-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The delete record by id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getDeleteRecordByIdEndpoint - Gets the delete record by id endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L164">models/EndpointFactory.ts:164</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDeleteRecordsByIdsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Delete<wbr/>Records<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><a href="#getDeleteRecordsByIdsEndpoint" 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="getDeleteRecordsByIdsEndpoint.getDeleteRecordsByIdsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Delete<wbr/>Records<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDeleteRecordsByIdsEndpoint.getDeleteRecordsByIdsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:164</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDeleteRecordsByIdsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Delete<wbr/>Records<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><a href="#getDeleteRecordsByIdsEndpoint" 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="getDeleteRecordsByIdsEndpoint.getDeleteRecordsByIdsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Delete<wbr/>Records<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDeleteRecordsByIdsEndpoint.getDeleteRecordsByIdsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The delete records by ids endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getDeleteRecordsByIdsEndpoint - Gets the delete records by ids endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L199">models/EndpointFactory.ts:199</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Field<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getFieldByIdEndpoint" 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="getFieldByIdEndpoint.getFieldByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Field<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFieldByIdEndpoint.getFieldByIdEndpoint-1" 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">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:199</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Field<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getFieldByIdEndpoint" 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="getFieldByIdEndpoint.getFieldByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Field<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFieldByIdEndpoint.getFieldByIdEndpoint-1" 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">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The field by id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsEndpoint - Gets the records endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L43">models/EndpointFactory.ts:43</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByAppIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><a href="#getFieldsByAppIdEndpoint" 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="getFieldsByAppIdEndpoint.getFieldsByAppIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFieldsByAppIdEndpoint.getFieldsByAppIdEndpoint-1" 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">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:43</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByAppIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><a href="#getFieldsByAppIdEndpoint" 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="getFieldsByAppIdEndpoint.getFieldsByAppIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFieldsByAppIdEndpoint.getFieldsByAppIdEndpoint-1" 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">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The fields by app id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFieldsByAppIdEndpoint - Gets the fields by app id endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L60">models/EndpointFactory.ts:60</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByIdsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Fields<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><a href="#getFieldsByIdsEndpoint" 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="getFieldsByIdsEndpoint.getFieldsByIdsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFieldsByIdsEndpoint.getFieldsByIdsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:60</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByIdsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Fields<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><a href="#getFieldsByIdsEndpoint" 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="getFieldsByIdsEndpoint.getFieldsByIdsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFieldsByIdsEndpoint.getFieldsByIdsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The fields by ids endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFieldsByIdsEndpoint - Gets the fields by ids endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L51">models/EndpointFactory.ts:51</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getFileByIdEndpoint" 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="getFileByIdEndpoint.getFileByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFileByIdEndpoint.getFileByIdEndpoint-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:51</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getFileByIdEndpoint" 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="getFileByIdEndpoint.getFileByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFileByIdEndpoint.getFileByIdEndpoint-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the file.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The file by id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFileByIdEndpoint - Gets the file by id endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L101">models/EndpointFactory.ts:101</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileInfoByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getFileInfoByIdEndpoint" 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="getFileInfoByIdEndpoint.getFileInfoByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFileInfoByIdEndpoint.getFileInfoByIdEndpoint-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:101</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileInfoByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getFileInfoByIdEndpoint" 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="getFileInfoByIdEndpoint.getFileInfoByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFileInfoByIdEndpoint.getFileInfoByIdEndpoint-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the file.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The file info by id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsEndpoint - Gets the records endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L71">models/EndpointFactory.ts:71</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getPingEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Ping<wbr/>Endpoint</span><a href="#getPingEndpoint" 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="getPingEndpoint.getPingEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Ping<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getPingEndpoint.getPingEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:71</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getPingEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Ping<wbr/>Endpoint</span><a href="#getPingEndpoint" 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="getPingEndpoint.getPingEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Ping<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getPingEndpoint.getPingEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The ping endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getPingEndpoint - Gets the ping endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L9">models/EndpointFactory.ts:9</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getQueryRecordsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Query<wbr/>Records<wbr/>Endpoint</span><a href="#getQueryRecordsEndpoint" 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="getQueryRecordsEndpoint.getQueryRecordsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Query<wbr/>Records<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getQueryRecordsEndpoint.getQueryRecordsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:9</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getQueryRecordsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Query<wbr/>Records<wbr/>Endpoint</span><a href="#getQueryRecordsEndpoint" 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="getQueryRecordsEndpoint.getQueryRecordsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Query<wbr/>Records<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getQueryRecordsEndpoint.getQueryRecordsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The query records endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getQueryRecordsEndpoint - Gets the query records endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L183">models/EndpointFactory.ts:183</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Record<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getRecordByIdEndpoint" 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="getRecordByIdEndpoint.getRecordByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Record<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getRecordByIdEndpoint.getRecordByIdEndpoint-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:183</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Record<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getRecordByIdEndpoint" 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="getRecordByIdEndpoint.getRecordByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Record<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getRecordByIdEndpoint.getRecordByIdEndpoint-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The get record by id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordByIdEndpoint - Gets the get record by id endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L154">models/EndpointFactory.ts:154</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByAppIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><a href="#getRecordsByAppIdEndpoint" 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="getRecordsByAppIdEndpoint.getRecordsByAppIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getRecordsByAppIdEndpoint.getRecordsByAppIdEndpoint-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:154</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByAppIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><a href="#getRecordsByAppIdEndpoint" 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="getRecordsByAppIdEndpoint.getRecordsByAppIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getRecordsByAppIdEndpoint.getRecordsByAppIdEndpoint-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The get records by app id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsByAppIdEndpoint - Gets the get records by app id endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L144">models/EndpointFactory.ts:144</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByIdsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Records<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><a href="#getRecordsByIdsEndpoint" 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="getRecordsByIdsEndpoint.getRecordsByIdsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getRecordsByIdsEndpoint.getRecordsByIdsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:144</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByIdsEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Records<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><a href="#getRecordsByIdsEndpoint" 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="getRecordsByIdsEndpoint.getRecordsByIdsEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>Ids<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getRecordsByIdsEndpoint.getRecordsByIdsEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The get records by ids endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsByIdsEndpoint - Gets the get records by ids endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L175">models/EndpointFactory.ts:175</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Report<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getReportByIdEndpoint" 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="getReportByIdEndpoint.getReportByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Report<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reportId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getReportByIdEndpoint.getReportByIdEndpoint-1" 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">reportId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the report.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:175</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportByIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Report<wbr/>By<wbr/>Id<wbr/>Endpoint</span><a href="#getReportByIdEndpoint" 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="getReportByIdEndpoint.getReportByIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Report<wbr/>By<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reportId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getReportByIdEndpoint.getReportByIdEndpoint-1" 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">reportId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the report.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The get report by id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getReportByIdEndpoint - Gets the get report by id endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L208">models/EndpointFactory.ts:208</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportsByAppIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><a href="#getReportsByAppIdEndpoint" 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="getReportsByAppIdEndpoint.getReportsByAppIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getReportsByAppIdEndpoint.getReportsByAppIdEndpoint-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:208</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportsByAppIdEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><a href="#getReportsByAppIdEndpoint" 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="getReportsByAppIdEndpoint.getReportsByAppIdEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getReportsByAppIdEndpoint.getReportsByAppIdEndpoint-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The get reports by app id endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getReportsByAppIdEndpoint - Gets the get reports by app id endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L217">models/EndpointFactory.ts:217</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSaveFileEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Save<wbr/>File<wbr/>Endpoint</span><a href="#getSaveFileEndpoint" 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="getSaveFileEndpoint.getSaveFileEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Save<wbr/>File<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getSaveFileEndpoint.getSaveFileEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:217</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSaveFileEndpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Save<wbr/>File<wbr/>Endpoint</span><a href="#getSaveFileEndpoint" 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="getSaveFileEndpoint.getSaveFileEndpoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Save<wbr/>File<wbr/>Endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getSaveFileEndpoint.getSaveFileEndpoint-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The save file endpoint.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getSaveFileEndpoint - Gets the save file endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/EndpointFactory.ts#L113">models/EndpointFactory.ts:113</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#getAddOrUpdateListItemEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item<wbr/>Endpoint</span></a><a href="#getAddOrUpdateRecordEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>Record<wbr/>Endpoint</span></a><a href="#getAppByIdEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>App<wbr/>By<wbr/>Id<wbr/>Endpoint</span></a><a href="#getAppsByIdsEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Apps<wbr/>By<wbr/>Ids<wbr/>Endpoint</span></a><a href="#getAppsEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Apps<wbr/>Endpoint</span></a><a href="#getDeleteFileByIdEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Delete<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span></a><a href="#getDeleteListItemEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Delete<wbr/>List<wbr/>Item<wbr/>Endpoint</span></a><a href="#getDeleteRecordByIdEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048">Line truncated
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/EndpointFactory.ts:113</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#getAddOrUpdateListItemEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item<wbr/>Endpoint</span></a><a href="#getAddOrUpdateRecordEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Add<wbr/>Or<wbr/>Update<wbr/>Record<wbr/>Endpoint</span></a><a href="#getAppByIdEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>App<wbr/>By<wbr/>Id<wbr/>Endpoint</span></a><a href="#getAppsByIdsEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Apps<wbr/>By<wbr/>Ids<wbr/>Endpoint</span></a><a href="#getAppsEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Apps<wbr/>Endpoint</span></a><a href="#getDeleteFileByIdEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Delete<wbr/>File<wbr/>By<wbr/>Id<wbr/>Endpoint</span></a><a href="#getDeleteListItemEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Delete<wbr/>List<wbr/>Item<wbr/>Endpoint</span></a><a href="#getDeleteRecordByIdEndpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Delete<wbr/>Record<wbr/>By<wbr/>Id<wbr/>Endpoint</span></a><a href="#getDeleteRecordsByIdsEndpoinLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="Field.html">Field</a></li></ul><h1>Class Field</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Field - Represents a Field.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#Field">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">Field</span><ul class="tsd-hierarchy"><li><a href="FormulaField.html" class="tsd-signature-type tsd-kind-class">FormulaField</a></li><li><a href="ListField.html" class="tsd-signature-type tsd-kind-class">ListField</a></li><li><a href="ReferenceField.html" class="tsd-signature-type tsd-kind-class">ReferenceField</a></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/Field.ts#L7">models/Field.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="Field.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#Field">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">Field</span><ul class="tsd-hierarchy"><li><a href="FormulaField.html" class="tsd-signature-type tsd-kind-class">FormulaField</a></li><li><a href="ListField.html" class="tsd-signature-type tsd-kind-class">ListField</a></li><li><a href="ReferenceField.html" class="tsd-signature-type tsd-kind-class">ReferenceField</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/Field.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="Field.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="Field.html#appId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
|
||||
<a href="Field.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
||||
<a href="Field.html#isRequired" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Required</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a></h4><ul>
|
||||
<li>A new Field.</li>
|
||||
</ul>
|
||||
<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/Field.ts#L54">models/Field.ts:54</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L16">models/Field.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L11">models/Field.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" 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">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/Field.ts#L36">models/Field.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" 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">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/Field.ts#L41">models/Field.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/Field.ts#L21">models/Field.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" 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">status</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FieldStatus.html" class="tsd-signature-type tsd-kind-enum">FieldStatus</a></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/Field.ts#L31">models/Field.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="..Line truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Field.ts:54</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in models/Field.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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"><ul><li>Defined in models/Field.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" 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">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Field.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" 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">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Field.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/Field.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" 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">status</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FieldStatus.html" class="tsd-signature-type tsd-kind-enum">FieldStatus</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Field.ts:31</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FieldType.html" class="tsd-signature-type tsd-kind-enum">FieldType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Field.ts:26</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-filterLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="File.html">File</a></li></ul><h1>Class File</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>File - Represents a file retrieved from Onspring.</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/File.ts#L6">models/File.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="File.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/File.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="File.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="File.html#contentLength" 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/>Length</span></a>
|
||||
<a href="File.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="File.html#fileName" 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/>Name</span></a>
|
||||
@@ -169,7 +169,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="File.html" class="tsd-signature-type tsd-kind-class">File</a></h4><ul>
|
||||
<li>A new instance of File.</li>
|
||||
</ul>
|
||||
<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/File.ts#L35">models/File.ts:35</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="contentLength" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>content<wbr/>Length</span><a href="#contentLength" 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/>Length</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/File.ts#L25">models/File.ts:25</a></li></ul></aside></section><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/File.ts#L20">models/File.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Name</span><a href="#fileName" 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/>Name</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/File.ts#L15">models/File.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stream</span><a href="#stream" 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">stream</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readable</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/File.ts#L10">models/File.ts:10</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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-cLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/File.ts:35</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="contentLength" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>content<wbr/>Length</span><a href="#contentLength" 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/>Length</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"><ul><li>Defined in models/File.ts:25</li></ul></aside></section><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/File.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Name</span><a href="#fileName" 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/>Name</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/File.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stream</span><a href="#stream" 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">stream</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readable</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/File.ts:10</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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");
|
||||
|
||||
@@ -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="FileListRecordValue.html">FileListRecordValue</a></li></ul><h1>Class FileListRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>FileListRecordValue - Represents a file list record value.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#FileListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">FileListRecordValue</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/FileListRecordValue.ts#L8">models/FileListRecordValue.ts:8</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="FileListRecordValue.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#FileListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">FileListRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/FileListRecordValue.ts:8</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="FileListRecordValue.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="FileListRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="FileListRecordValue.html#type" 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>type</span></a>
|
||||
<a href="FileListRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="FileListRecordValue.html" class="tsd-signature-type tsd-kind-class">FileListRecordValue</a></h4><ul>
|
||||
<li>A new instance of FileListRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/FileListRecordValue.ts#L15">models/FileListRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/FileListRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="FormulaField.html">FormulaField</a></li></ul><h1>Class FormulaField</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>FormulaField - Represents a formula field.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#FormulaField">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><ul class="tsd-hierarchy"><li><span class="target">FormulaField</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/FormulaField.ts#L10">models/FormulaField.ts:10</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="FormulaField.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#FormulaField">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><ul class="tsd-hierarchy"><li><span class="target">FormulaField</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/FormulaField.ts:10</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="FormulaField.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="FormulaField.html#appId" 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>app<wbr/>Id</span></a>
|
||||
<a href="FormulaField.html#id" 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>id</span></a>
|
||||
<a href="FormulaField.html#isRequired" 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>is<wbr/>Required</span></a>
|
||||
@@ -179,7 +179,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="FormulaField.html" class="tsd-signature-type tsd-kind-class">FormulaField</a></h4><ul>
|
||||
<li>A new FormulaField.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/FormulaField.ts#L34">models/FormulaField.ts:34</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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="Field.html">Field</a>.<a href="Field.html#appId">appId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L16">models/Field.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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="Field.html">Field</a>.<a href="Field.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L11">models/Field.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" 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">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isRequired">isRequired</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L36">models/Field.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" 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">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isUnique">isUnique</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L41">models/Field.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L21">models/Field.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="outputType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>output<wbr/>Type</span><a href="#outputType" 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">output<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FormulaOutputType.html" class="tsd-signature-type tsLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p><ul><li>Defined in models/FormulaField.ts:34</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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="Field.html">Field</a>.<a href="Field.html#appId">appId</a></p><ul><li>Defined in models/Field.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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="Field.html">Field</a>.<a href="Field.html#id">id</a></p><ul><li>Defined in models/Field.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" 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">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isRequired">isRequired</a></p><ul><li>Defined in models/Field.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" 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">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isUnique">isUnique</a></p><ul><li>Defined in models/Field.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#name">name</a></p><ul><li>Defined in models/Field.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="outputType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>output<wbr/>Type</span><a href="#outputType" 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">output<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FormulaOutputType.html" class="tsd-signature-type tsd-kind-enum">FormulaOutputType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/FormulaField.ts:14</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" 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">status</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FieldStatus.html" class="tsd-signature-type tsd-kind-enum">FieldStatus<Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="GetPagedAppsResponse.html">GetPagedAppsResponse</a></li></ul><h1>Class GetPagedAppsResponse</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>GetPagedAppsResponse - A paged response model for the GetApps method.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#GetPagedAppsResponse">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="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GetPagedAppsResponse</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/GetPagedAppsResponse.ts#L7">models/GetPagedAppsResponse.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="GetPagedAppsResponse.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#GetPagedAppsResponse">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="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GetPagedAppsResponse</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/GetPagedAppsResponse.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="GetPagedAppsResponse.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="GetPagedAppsResponse.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="GetPagedAppsResponse.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="GetPagedAppsResponse.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="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a></h4><ul>
|
||||
<li>A new instance of the GetPagedAppsResponse 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/GetPagedAppsResponse.ts#L17">models/GetPagedAppsResponse.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="App.html" class="tsd-signature-type tsd-kind-class">App</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 class="tsd-naLine 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/GetPagedAppsResponse.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="App.html" class="tsd-signature-type tsd-kind-class">App</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="M8.35422Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="GetPagedFieldsResponse.html">GetPagedFieldsResponse</a></li></ul><h1>Class GetPagedFieldsResponse</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>GetPagedFieldsResponse - A response containing a paged collection of fields.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#GetPagedFieldsResponse">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="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GetPagedFieldsResponse</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/GetPagedFieldsResponse.ts#L7">models/GetPagedFieldsResponse.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="GetPagedFieldsResponse.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#GetPagedFieldsResponse">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="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GetPagedFieldsResponse</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/GetPagedFieldsResponse.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="GetPagedFieldsResponse.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="GetPagedFieldsResponse.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="GetPagedFieldsResponse.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="GetPagedFieldsResponse.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="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a></h4><ul>
|
||||
<li>A new instance of the GetPagedAppsResponse 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/GetPagedFieldsResponse.ts#L17">models/GetPagedFieldsResponse.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="Field.html" class="tsd-signature-type tsd-kind-class">Field</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 classLine 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/GetPagedFieldsResponse.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="Field.html" class="tsd-signature-type tsd-kind-class">Field</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="M8Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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");
|
||||
|
||||
@@ -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="GetPagedReportsResponse.html">GetPagedReportsResponse</a></li></ul><h1>Class GetPagedReportsResponse</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>GetPagedReportsResponse - Represents a response containing a paged list of reports.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#GetPagedReportsResponse">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="Report.html" class="tsd-signature-type tsd-kind-class">Report</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GetPagedReportsResponse</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/GetPagedReportsResponse.ts#L7">models/GetPagedReportsResponse.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="GetPagedReportsResponse.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#GetPagedReportsResponse">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="Report.html" class="tsd-signature-type tsd-kind-class">Report</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GetPagedReportsResponse</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/GetPagedReportsResponse.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="GetPagedReportsResponse.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="GetPagedReportsResponse.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="GetPagedReportsResponse.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="GetPagedReportsResponse.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="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a></h4><ul>
|
||||
<li>A new instance of the GetPagedReportsResponse 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/GetPagedReportsResponse.ts#L17">models/GetPagedReportsResponse.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="Report.html" class="tsd-signature-type tsd-kind-class">Report</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/GetPagedReportsResponse.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="Report.html" class="tsd-signature-type tsd-kind-class">Report</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");
|
||||
|
||||
@@ -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="GetRecordRequest.html">GetRecordRequest</a></li></ul><h1>Class GetRecordRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>GetRecordRequest - A request to get a record.</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/GetRecordRequest.ts#L6">models/GetRecordRequest.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="GetRecordRequest.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/GetRecordRequest.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="GetRecordRequest.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="GetRecordRequest.html#appId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
|
||||
<a href="GetRecordRequest.html#dataFormat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Format</span></a>
|
||||
<a href="GetRecordRequest.html#fieldIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Ids</span></a>
|
||||
@@ -169,7 +169,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="GetRecordRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordRequest</a></h4><ul>
|
||||
<li>A new instance of GetRecordRequest.</li>
|
||||
</ul>
|
||||
<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/GetRecordRequest.ts#L35">models/GetRecordRequest.ts:35</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/GetRecordRequest.ts#L10">models/GetRecordRequest.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dataFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data<wbr/>Format</span><a href="#dataFormat" 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">data<wbr/>Format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a></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/GetRecordRequest.ts#L25">models/GetRecordRequest.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Ids</span><a href="#fieldIds" 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">field<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</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/GetRecordRequest.ts#L20">models/GetRecordRequest.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" 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">record<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/GetRecordRequest.ts#L15">models/GetRecordRequest.ts:15</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordRequest.ts:35</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in models/GetRecordRequest.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dataFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data<wbr/>Format</span><a href="#dataFormat" 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">data<wbr/>Format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordRequest.ts:25</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Ids</span><a href="#fieldIds" 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">field<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordRequest.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" 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">record<wbr/>Id</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"><ul><li>Defined in models/GetRecordRequest.ts:15</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" xLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="GetRecordsByAppIdRequest.html">GetRecordsByAppIdRequest</a></li></ul><h1>Class GetRecordsByAppIdRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>GetRecordsByAppIdRequest - Represents a request to get records by app id.</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/GetRecordsByAppIdRequest.ts#L7">models/GetRecordsByAppIdRequest.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="GetRecordsByAppIdRequest.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/GetRecordsByAppIdRequest.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="GetRecordsByAppIdRequest.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="GetRecordsByAppIdRequest.html#appId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
|
||||
<a href="GetRecordsByAppIdRequest.html#dataFormat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Format</span></a>
|
||||
<a href="GetRecordsByAppIdRequest.html#fieldIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Ids</span></a>
|
||||
@@ -169,7 +169,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="GetRecordsByAppIdRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordsByAppIdRequest</a></h4><ul>
|
||||
<li>A new instance of GetRecordsByAppIdRequest.</li>
|
||||
</ul>
|
||||
<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/GetRecordsByAppIdRequest.ts#L36">models/GetRecordsByAppIdRequest.ts:36</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/GetRecordsByAppIdRequest.ts#L11">models/GetRecordsByAppIdRequest.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dataFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data<wbr/>Format</span><a href="#dataFormat" 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">data<wbr/>Format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a><span class="tsd-signature-symbol"> = DataFormat.Raw</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/GetRecordsByAppIdRequest.ts#L21">models/GetRecordsByAppIdRequest.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Ids</span><a href="#fieldIds" 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">field<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</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/GetRecordsByAppIdRequest.ts#L16">models/GetRecordsByAppIdRequest.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pagingRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>paging<wbr/>Request</span><a href="#pagingRequest" 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">paging<wbr/>Request</span><span class="tsd-signature-symbol">:</span> <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a></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/GetRecordsByAppIdRequest.ts#L26">models/GetRecordsByAppIdRequest.ts:26</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="roLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordsByAppIdRequest.ts:36</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in models/GetRecordsByAppIdRequest.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dataFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data<wbr/>Format</span><a href="#dataFormat" 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">data<wbr/>Format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a><span class="tsd-signature-symbol"> = DataFormat.Raw</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordsByAppIdRequest.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Ids</span><a href="#fieldIds" 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">field<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordsByAppIdRequest.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pagingRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>paging<wbr/>Request</span><a href="#pagingRequest" 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">paging<wbr/>Request</span><span class="tsd-signature-symbol">:</span> <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordsByAppIdRequest.ts:26</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-fiLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="GetRecordsRequest.html">GetRecordsRequest</a></li></ul><h1>Class GetRecordsRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>GetRecordsRequest - Request to get records by their ids</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/GetRecordsRequest.ts#L6">models/GetRecordsRequest.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="GetRecordsRequest.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/GetRecordsRequest.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="GetRecordsRequest.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="GetRecordsRequest.html#appId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
|
||||
<a href="GetRecordsRequest.html#dataFormat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Format</span></a>
|
||||
<a href="GetRecordsRequest.html#fieldIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Ids</span></a>
|
||||
@@ -166,7 +166,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">recordIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The ids of the records to get.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span><div class="tsd-comment tsd-typography"><p>The ids of the fields to include in the response.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">dataFormat</span>: <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a><span class="tsd-signature-symbol"> = DataFormat.Raw</span></span><div class="tsd-comment tsd-typography"><p>The format of the data in the response.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="GetRecordsRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordsRequest</a></h4><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/GetRecordsRequest.ts#L34">models/GetRecordsRequest.ts:34</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/GetRecordsRequest.ts#L10">models/GetRecordsRequest.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dataFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data<wbr/>Format</span><a href="#dataFormat" 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">data<wbr/>Format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a></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/GetRecordsRequest.ts#L25">models/GetRecordsRequest.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Ids</span><a href="#fieldIds" 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">field<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</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/GetRecordsRequest.ts#L20">models/GetRecordsRequest.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Ids</span><a href="#recordIds" 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">record<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</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/GetRecordsRequest.ts#L15">models/GetRecordsRequest.ts:15</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.Line truncated
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="GetRecordsRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordsRequest</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordsRequest.ts:34</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in models/GetRecordsRequest.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dataFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data<wbr/>Format</span><a href="#dataFormat" 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">data<wbr/>Format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordsRequest.ts:25</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Ids</span><a href="#fieldIds" 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">field<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordsRequest.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Ids</span><a href="#recordIds" 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">record<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/GetRecordsRequest.ts:15</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></labelLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="GuidListRecordValue.html">GuidListRecordValue</a></li></ul><h1>Class GuidListRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>GuidListRecordValue - Represents a guid list record value.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#GuidListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GuidListRecordValue</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/GuidListRecordValue.ts#L7">models/GuidListRecordValue.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="GuidListRecordValue.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#GuidListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GuidListRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/GuidListRecordValue.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="GuidListRecordValue.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="GuidListRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="GuidListRecordValue.html#type" 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>type</span></a>
|
||||
<a href="GuidListRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="GuidListRecordValue.html" class="tsd-signature-type tsd-kind-class">GuidListRecordValue</a></h4><ul>
|
||||
<li>A new instance of GuidListRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/GuidListRecordValue.ts#L14">models/GuidListRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/GuidListRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="GuidRecordValue.html">GuidRecordValue</a></li></ul><h1>Class GuidRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>GuidRecordValue - Represents a guid record value.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#GuidRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GuidRecordValue</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/GuidRecordValue.ts#L7">models/GuidRecordValue.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="GuidRecordValue.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#GuidRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GuidRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/GuidRecordValue.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="GuidRecordValue.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="GuidRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="GuidRecordValue.html#type" 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>type</span></a>
|
||||
<a href="GuidRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="GuidRecordValue.html" class="tsd-signature-type tsd-kind-class">GuidRecordValue</a></h4><ul>
|
||||
<li>A new instance of GuidRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/GuidRecordValue.ts#L14">models/GuidRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/GuidRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="IntegerListRecordValue.html">IntegerListRecordValue</a></li></ul><h1>Class IntegerListRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>IntegerListRecordValue - Represents an integer list record value.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#IntegerListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IntegerListRecordValue</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/IntegerListRecordValue.ts#L7">models/IntegerListRecordValue.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="IntegerListRecordValue.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#IntegerListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IntegerListRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/IntegerListRecordValue.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="IntegerListRecordValue.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="IntegerListRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="IntegerListRecordValue.html#type" 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>type</span></a>
|
||||
<a href="IntegerListRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="IntegerListRecordValue.html" class="tsd-signature-type tsd-kind-class">IntegerListRecordValue</a></h4><ul>
|
||||
<li>A new instance of IntegerListRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/IntegerListRecordValue.ts#L14">models/IntegerListRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/IntegerListRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="IntegerRecordValue.html">IntegerRecordValue</a></li></ul><h1>Class IntegerRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>IntegerRecordValue - A record value represented by an integer.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#IntegerRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IntegerRecordValue</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/IntegerRecordValue.ts#L7">models/IntegerRecordValue.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="IntegerRecordValue.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#IntegerRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IntegerRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/IntegerRecordValue.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="IntegerRecordValue.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="IntegerRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="IntegerRecordValue.html#type" 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>type</span></a>
|
||||
<a href="IntegerRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="IntegerRecordValue.html" class="tsd-signature-type tsd-kind-class">IntegerRecordValue</a></h4><ul>
|
||||
<li>A new instance of IntegerRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/IntegerRecordValue.ts#L14">models/IntegerRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/IntegerRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="ListField.html">ListField</a></li></ul><h1>Class ListField</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ListField - Represents a list field.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ListField">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><ul class="tsd-hierarchy"><li><span class="target">ListField</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/ListField.ts#L10">models/ListField.ts:10</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="ListField.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#ListField">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><ul class="tsd-hierarchy"><li><span class="target">ListField</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/ListField.ts:10</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="ListField.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="ListField.html#appId" 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>app<wbr/>Id</span></a>
|
||||
<a href="ListField.html#id" 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>id</span></a>
|
||||
<a href="ListField.html#isRequired" 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>is<wbr/>Required</span></a>
|
||||
@@ -181,7 +181,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ListField.html" class="tsd-signature-type tsd-kind-class">ListField</a></h4><ul>
|
||||
<li>A new ListField.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListField.ts#L40">models/ListField.ts:40</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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="Field.html">Field</a>.<a href="Field.html#appId">appId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L16">models/Field.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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="Field.html">Field</a>.<a href="Field.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L11">models/Field.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" 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">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isRequired">isRequired</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L36">models/Field.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" 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">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isUnique">isUnique</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L41">models/Field.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="listId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Id</span><a href="#listId" 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">list<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListField.ts#L19">models/ListField.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="multiplicity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>multiplicity</span><a href="#multiplicity" 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">multiplicity</span><span class="tsd-signature-symbol">:</span> <a href="../enums/Multiplicity.html" class="tsd-signature-type tsd-kind-enum">Multiplicity</a></div><div class="tsd-comment tsd-typography"></div><aside claLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p><ul><li>Defined in models/ListField.ts:40</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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="Field.html">Field</a>.<a href="Field.html#appId">appId</a></p><ul><li>Defined in models/Field.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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="Field.html">Field</a>.<a href="Field.html#id">id</a></p><ul><li>Defined in models/Field.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" 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">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isRequired">isRequired</a></p><ul><li>Defined in models/Field.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" 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">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isUnique">isUnique</a></p><ul><li>Defined in models/Field.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="listId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Id</span><a href="#listId" 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">list<wbr/>Id</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"><ul><li>Defined in models/ListField.ts:19</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="multiplicity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>multiplicity</span><a href="#multiplicity" 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">multiplicity</span><span class="tsd-signature-symbol">:</span> <a href="../enums/Multiplicity.html" class="tsd-signature-type tsd-kind-enum">Multiplicity</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ListField.ts:14</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#namLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="ListItemRequest.html">ListItemRequest</a></li></ul><h1>Class ListItemRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ListItemRequest - Represents a list item request</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/ListItemRequest.ts#L4">models/ListItemRequest.ts:4</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="ListItemRequest.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/ListItemRequest.ts:4</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="ListItemRequest.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="ListItemRequest.html#color" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color</span></a>
|
||||
<a href="ListItemRequest.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
||||
<a href="ListItemRequest.html#listId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list<wbr/>Id</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="ListItemRequest.html" class="tsd-signature-type tsd-kind-class">ListItemRequest</a></h4><ul>
|
||||
<li>A new instance of the ListItemRequest class.</li>
|
||||
</ul>
|
||||
<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/ListItemRequest.ts#L39">models/ListItemRequest.ts:39</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="color" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>color</span><a href="#color" 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">color</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/ListItemRequest.ts#L28">models/ListItemRequest.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/ListItemRequest.ts#L13">models/ListItemRequest.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="listId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Id</span><a href="#listId" 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">list<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListItemRequest.ts#L8">models/ListItemRequest.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/ListItemRequest.ts#L18">models/ListItemRequest.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="numericValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>numeric<wbr/>Value</span><a href="#numericValue" 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">numeric<wbr/>Value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListItemRequest.ts#L23">models/ListItemRequest.ts:23</a></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><paLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ListItemRequest.ts:39</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="color" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>color</span><a href="#color" 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">color</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/ListItemRequest.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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/ListItemRequest.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="listId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Id</span><a href="#listId" 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">list<wbr/>Id</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"><ul><li>Defined in models/ListItemRequest.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/ListItemRequest.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="numericValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>numeric<wbr/>Value</span><a href="#numericValue" 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">numeric<wbr/>Value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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"><ul><li>Defined in models/ListItemRequest.ts:23</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-fLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -157,13 +157,13 @@
|
||||
--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="ListItemResponse.html">ListItemResponse</a></li></ul><h1>Class ListItemResponse</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ListItemResponse - Represents a respons when a list item is created or updated.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ListItemResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">ListItemResponse</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/ListItemResponse.ts#L5">models/ListItemResponse.ts:5</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="ListItemResponse.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#ListItemResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">ListItemResponse</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/ListItemResponse.ts:5</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="ListItemResponse.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="ListItemResponse.html#id" 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>id</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_ListItemResponse" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>List<wbr/>Item<wbr/>Response</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><a href="#constructor.new_ListItemResponse" 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">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the list item.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a></h4><ul>
|
||||
<li>A new instance of ListItemResponse.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListItemResponse.ts#L11">models/ListItemResponse.ts:11</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="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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"><p>Inherited from <a href="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/CreatedWithIdResponse.ts#L8">models/CreatedWithIdResponse.ts:8</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ulLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#constructor">constructor</a></p><ul><li>Defined in models/ListItemResponse.ts:11</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="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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"><p>Inherited from <a href="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#id">id</a></p><ul><li>Defined in models/CreatedWithIdResponse.ts:8</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="ListValue.html">ListValue</a></li></ul><h1>Class ListValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ListValue - Represents a list value.</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/ListValue.ts#L4">models/ListValue.ts:4</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="ListValue.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/ListValue.ts:4</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="ListValue.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="ListValue.html#color" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color</span></a>
|
||||
<a href="ListValue.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
||||
<a href="ListValue.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</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="ListValue.html" class="tsd-signature-type tsd-kind-class">ListValue</a></h4><ul>
|
||||
<li>A new ListValue.</li>
|
||||
</ul>
|
||||
<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/ListValue.ts#L39">models/ListValue.ts:39</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="color" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>color</span><a href="#color" 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">color</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/ListValue.ts#L28">models/ListValue.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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/ListValue.ts#L8">models/ListValue.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/ListValue.ts#L13">models/ListValue.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="numericValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>numeric<wbr/>Value</span><a href="#numericValue" 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">numeric<wbr/>Value</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListValue.ts#L23">models/ListValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sortOrder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sort<wbr/>Order</span><a href="#sortOrder" 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">sort<wbr/>Order</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListValue.ts#L18">models/ListValue.ts:18</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svgLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ListValue.ts:39</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="color" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>color</span><a href="#color" 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">color</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/ListValue.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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/ListValue.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/ListValue.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="numericValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>numeric<wbr/>Value</span><a href="#numericValue" 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">numeric<wbr/>Value</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"><ul><li>Defined in models/ListValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sortOrder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sort<wbr/>Order</span><a href="#sortOrder" 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">sort<wbr/>Order</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"><ul><li>Defined in models/ListValue.ts:18</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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" Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="OnspringClient.html">OnspringClient</a></li></ul><h1>Class OnspringClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>OnspringClient - A client that can communicate with the Onspring API.</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/OnspringClient.ts#L38">models/OnspringClient.ts:38</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="OnspringClient.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/OnspringClient.ts:38</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="OnspringClient.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="OnspringClient.html#_client" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_client</span></a>
|
||||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="OnspringClient.html#addOrUpdateListItem" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span></a>
|
||||
<a href="OnspringClient.html#canConnect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Connect</span></a>
|
||||
@@ -196,156 +196,156 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>Thrown when the apiKey is null/undefined/empty/whitespace.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L52">models/OnspringClient.ts:52</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-private"><a id="_client" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>_client</span><a href="#_client" 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">_client</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span></div><div class="tsd-comment tsd-typography"><p>client - The axios instance that will be used to make requests to the Onspring API.</p>
|
||||
</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/OnspringClient.ts#L42">models/OnspringClient.ts:42</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addOrUpdateListItem" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span><a href="#addOrUpdateListItem" 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="addOrUpdateListItem.addOrUpdateListItem-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listItemRequest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#addOrUpdateListItem.addOrUpdateListItem-1" 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">listItemRequest</span>: <a href="ListItemRequest.html" class="tsd-signature-type tsd-kind-class">ListItemRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to add or update the list item.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:52</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-private"><a id="_client" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>_client</span><a href="#_client" 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">_client</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span></div><div class="tsd-comment tsd-typography"><p>client - The axios instance that will be used to make requests to the Onspring API.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:42</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addOrUpdateListItem" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span><a href="#addOrUpdateListItem" 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="addOrUpdateListItem.addOrUpdateListItem-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listItemRequest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#addOrUpdateListItem.addOrUpdateListItem-1" 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">listItemRequest</span>: <a href="ListItemRequest.html" class="tsd-signature-type tsd-kind-class">ListItemRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to add or update the list item.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type ListItemResponse.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>addOrUpdateListItem - Adds or updates a list item depending on if an id is provided or not.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L312">models/OnspringClient.ts:312</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="canConnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>can<wbr/>Connect</span><a href="#canConnect" 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="canConnect.canConnect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">can<wbr/>Connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#canConnect.canConnect-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:312</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="canConnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>can<wbr/>Connect</span><a href="#canConnect" 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="canConnect.canConnect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">can<wbr/>Connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#canConnect.canConnect-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to a boolean indicating if the client can connect to the Onspring API.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>canConnect - Determines if the client can connect to the Onspring API.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L88">models/OnspringClient.ts:88</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="delete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>delete</span><a href="#delete" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="delete.delete-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#delete.delete-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#delete.delete-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#delete.delete-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="delete.delete-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:88</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="delete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>delete</span><a href="#delete" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="delete.delete-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#delete.delete-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#delete.delete-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#delete.delete-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="delete.delete-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#delete.delete-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type T.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>delete - Makes a DELETE request to the specified endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L588">models/OnspringClient.ts:588</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteFileById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>File<wbr/>By<wbr/>Id</span><a href="#deleteFileById" 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="deleteFileById.deleteFileById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>File<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteFileById.deleteFileById-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the file is held on.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:588</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteFileById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>File<wbr/>By<wbr/>Id</span><a href="#deleteFileById" 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="deleteFileById.deleteFileById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>File<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteFileById.deleteFileById-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the file is held on.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field that the file is held in.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the file to delete.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type any.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>deleteFileById - Deletes a file by its id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L292">models/OnspringClient.ts:292</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteListItemById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span><a href="#deleteListItemById" 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="deleteListItemById.deleteListItemById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listId</span>, <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteListItemById.deleteListItemById-1" 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">listId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the list that the list item belongs to.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:292</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteListItemById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span><a href="#deleteListItemById" 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="deleteListItemById.deleteListItemById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listId</span>, <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteListItemById.deleteListItemById-1" 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">listId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the list that the list item belongs to.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">itemId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the list item to delete.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type any.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>deleteListItemById - Deletes a list item by its id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L334">models/OnspringClient.ts:334</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteRecordById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Record<wbr/>By<wbr/>Id</span><a href="#deleteRecordById" 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="deleteRecordById.deleteRecordById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Record<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteRecordById.deleteRecordById-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app that the record belongs to.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:334</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteRecordById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Record<wbr/>By<wbr/>Id</span><a href="#deleteRecordById" 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="deleteRecordById.deleteRecordById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Record<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteRecordById.deleteRecordById-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app that the record belongs to.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record to delete.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type any.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>deleteRecordById - Deletes a record by its id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L455">models/OnspringClient.ts:455</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteRecordsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Records<wbr/>By<wbr/>Ids</span><a href="#deleteRecordsByIds" 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="deleteRecordsByIds.deleteRecordsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Records<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordIds</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteRecordsByIds.deleteRecordsByIds-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app that the records belong to.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:455</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteRecordsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Records<wbr/>By<wbr/>Ids</span><a href="#deleteRecordsByIds" 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="deleteRecordsByIds.deleteRecordsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Records<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordIds</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteRecordsByIds.deleteRecordsByIds-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app that the records belong to.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">recordIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The ids of the records to delete.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type any.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>deleteRecordsByIds - Deletes records by their ids.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L473">models/OnspringClient.ts:473</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get</span><a href="#get" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#get.get-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#get.get-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#get.get-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="get.get-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:473</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get</span><a href="#get" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#get.get-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#get.get-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#get.get-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="get.get-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#get.get-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type T.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>get - Makes a GET request to the specified endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L539">models/OnspringClient.ts:539</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>App<wbr/>By<wbr/>Id</span><a href="#getAppById" 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="getAppById.getAppById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>App<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAppById.getAppById-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app to get.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:539</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>App<wbr/>By<wbr/>Id</span><a href="#getAppById" 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="getAppById.getAppById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>App<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAppById.getAppById-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app to get.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type App.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getAppById - Gets an app by its id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L119">models/OnspringClient.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getApps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Apps</span><a href="#getApps" 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="getApps.getApps-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pagingRequest</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getApps.getApps-1" 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">pagingRequest</span>: <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>The paging request that will be used to get the apps.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getApps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Apps</span><a href="#getApps" 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="getApps.getApps-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pagingRequest</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getApps.getApps-1" 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">pagingRequest</span>: <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>The paging request that will be used to get the apps.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type GetPagedAppsResponse.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getApps - Gets a paged list of apps.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L100">models/OnspringClient.ts:100</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Apps<wbr/>By<wbr/>Ids</span><a href="#getAppsByIds" 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="getAppsByIds.getAppsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appIds</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAppsByIds.getAppsByIds-1" 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">appIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The ids of the apps to get.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:100</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Apps<wbr/>By<wbr/>Ids</span><a href="#getAppsByIds" 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="getAppsByIds.getAppsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appIds</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAppsByIds.getAppsByIds-1" 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">appIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The ids of the apps to get.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type CollectionResponse<App>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getAppsByIds - Gets a list of apps by their ids.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L136">models/OnspringClient.ts:136</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Field<wbr/>By<wbr/>Id</span><a href="#getFieldById" 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="getFieldById.getFieldById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Field<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFieldById.getFieldById-1" 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">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field to get.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:136</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Field<wbr/>By<wbr/>Id</span><a href="#getFieldById" 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="getFieldById.getFieldById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Field<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFieldById.getFieldById-1" 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">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field to get.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type Field.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFieldById - Gets a field by its id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L155">models/OnspringClient.ts:155</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span><a href="#getFieldsByAppId" 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="getFieldsByAppId.getFieldsByAppId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">pagingRequest</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFieldsByAppId.getFieldsByAppId-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app to get the fields for.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:155</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span><a href="#getFieldsByAppId" 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="getFieldsByAppId.getFieldsByAppId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">pagingRequest</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFieldsByAppId.getFieldsByAppId-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app to get the fields for.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">pagingRequest</span>: <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>The paging request that will be used to get the fields.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type GetPagedFieldsResponse.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFieldsByAppId - Gets a paged list of fields by an app id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L191">models/OnspringClient.ts:191</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Fields<wbr/>By<wbr/>Ids</span><a href="#getFieldsByIds" 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="getFieldsByIds.getFieldsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldIds</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFieldsByIds.getFieldsByIds-1" 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">fieldIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The ids of the fields to get.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:191</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Fields<wbr/>By<wbr/>Ids</span><a href="#getFieldsByIds" 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="getFieldsByIds.getFieldsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldIds</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFieldsByIds.getFieldsByIds-1" 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">fieldIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The ids of the fields to get.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type CollectionResponse<Field>.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFieldsByIds - Gets a list of fields by their ids.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L171">models/OnspringClient.ts:171</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>File<wbr/>By<wbr/>Id</span><a href="#getFileById" 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="getFileById.getFileById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFileById.getFileById-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the file is attached to.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:171</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>File<wbr/>By<wbr/>Id</span><a href="#getFileById" 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="getFileById.getFileById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFileById.getFileById-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the file is attached to.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field that the file is attached to.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the file to get.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type File.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFileById - Gets a file by its id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L240">models/OnspringClient.ts:240</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileInfoById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span><a href="#getFileInfoById" 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="getFileInfoById.getFileInfoById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFileInfoById.getFileInfoById-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the file is attached to.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:240</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileInfoById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span><a href="#getFileInfoById" 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="getFileInfoById.getFileInfoById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFileInfoById.getFileInfoById-1" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the file is attached to.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field that the file is attached to.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the file to get the information for.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type FileInfo.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFileInfoById - Gets a file's information by its id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L213">models/OnspringClient.ts:213</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Record<wbr/>By<wbr/>Id</span><a href="#getRecordById" 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="getRecordById.getRecordById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Record<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</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><span class="tsd-signature-symbol">></span><a href="#getRecordById.getRecordById-1" 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">request</span>: <a href="GetRecordRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to get the record.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:213</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Record<wbr/>By<wbr/>Id</span><a href="#getRecordById" 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="getRecordById.getRecordById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Record<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</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><span class="tsd-signature-symbol">></span><a href="#getRecordById.getRecordById-1" 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">request</span>: <a href="GetRecordRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to get the record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</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><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type Record.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordById - Gets a record by its id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L372">models/OnspringClient.ts:372</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span><a href="#getRecordsByAppId" 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="getRecordsByAppId.getRecordsByAppId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getRecordsByAppId.getRecordsByAppId-1" 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">request</span>: <a href="GetRecordsByAppIdRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordsByAppIdRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to get the records.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:372</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span><a href="#getRecordsByAppId" 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="getRecordsByAppId.getRecordsByAppId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getRecordsByAppId.getRecordsByAppId-1" 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">request</span>: <a href="GetRecordsByAppIdRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordsByAppIdRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to get the records.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type GetPagedRecordsResponse.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsByAppId - Gets records by an app id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L348">models/OnspringClient.ts:348</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>By<wbr/>Ids</span><a href="#getRecordsByIds" 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="getRecordsByIds.getRecordsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</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><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getRecordsByIds.getRecordsByIds-1" 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">request</span>: <a href="GetRecordsRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordsRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to get the records.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:348</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>By<wbr/>Ids</span><a href="#getRecordsByIds" 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="getRecordsByIds.getRecordsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</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><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getRecordsByIds.getRecordsByIds-1" 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">request</span>: <a href="GetRecordsRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordsRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to get the records.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</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><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type CollectionResponse of type Record.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsByIds - Gets records by their ids.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L392">models/OnspringClient.ts:392</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Report<wbr/>By<wbr/>Id</span><a href="#getReportById" 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="getReportById.getReportById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Report<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reportId</span>, <span class="tsd-kind-parameter">apiDataFormat</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">dataType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getReportById.getReportById-1" 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">reportId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the report to get.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:392</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Report<wbr/>By<wbr/>Id</span><a href="#getReportById" 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="getReportById.getReportById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Report<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reportId</span>, <span class="tsd-kind-parameter">apiDataFormat</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">dataType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getReportById.getReportById-1" 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">reportId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the report to get.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">apiDataFormat</span>: <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a><span class="tsd-signature-symbol"> = DataFormat.Raw</span></span><div class="tsd-comment tsd-typography"><p>The data format that the report data will be returned in.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">dataType</span>: <a href="../enums/ReportDataType.html" class="tsd-signature-type tsd-kind-enum">ReportDataType</a><span class="tsd-signature-symbol"> = ReportDataType.ReportData</span></span><div class="tsd-comment tsd-typography"><p>The type of data that will be returned.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type ReportData.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getReportById - Gets a report by its id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L513">models/OnspringClient.ts:513</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportsByAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span><a href="#getReportsByAppId" 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="getReportsByAppId.getReportsByAppId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">pagingRequest</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getReportsByAppId.getReportsByAppId-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app to get the reports for.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:513</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportsByAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span><a href="#getReportsByAppId" 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="getReportsByAppId.getReportsByAppId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">pagingRequest</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getReportsByAppId.getReportsByAppId-1" 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">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app to get the reports for.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">pagingRequest</span>: <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>The paging request that will be used to get the reports.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type GetPagedReportsResponse.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getReportsByAppId - Gets a paged list of reports by the app id.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L491">models/OnspringClient.ts:491</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="post" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>post</span><a href="#post" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="post.post-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">post</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#post.post-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#post.post-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#post.post-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="post.post-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:491</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="post" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>post</span><a href="#post" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="post.post-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">post</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#post.post-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#post.post-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#post.post-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="post.post-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The data that will be sent with the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#post.post-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type T.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>post - Makes a POST request to the specified endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L555">models/OnspringClient.ts:555</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="put" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>put</span><a href="#put" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="put.put-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">put</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#put.put-1.T-3">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#put.put-1.T-3">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#put.put-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="put.put-1.T-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:555</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="put" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>put</span><a href="#put" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="put.put-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">put</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#put.put-1.T-3">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#put.put-1.T-3">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#put.put-1" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="put.put-1.T-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The data that will be sent with the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#put.put-1.T-3">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type T.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>put - Makes a PUT request to the specified endpoint.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L572">models/OnspringClient.ts:572</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="queryRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query<wbr/>Records</span><a href="#queryRecords" 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="queryRecords.queryRecords-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">query<wbr/>Records</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#queryRecords.queryRecords-1" 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">request</span>: <a href="QueryRecordsRequest.html" class="tsd-signature-type tsd-kind-class">QueryRecordsRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to query for records.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:572</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="queryRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query<wbr/>Records</span><a href="#queryRecords" 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="queryRecords.queryRecords-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">query<wbr/>Records</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#queryRecords.queryRecords-1" 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">request</span>: <a href="QueryRecordsRequest.html" class="tsd-signature-type tsd-kind-class">QueryRecordsRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to query for records.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type GetPagedRecordsResponse.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsByQuery - Gets records by a query.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L410">models/OnspringClient.ts:410</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>File</span><a href="#saveFile" 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="saveFile.saveFile-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#saveFile.saveFile-1" 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">request</span>: <a href="SaveFileRequest.html" class="tsd-signature-type tsd-kind-class">SaveFileRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to save the file.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:410</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>File</span><a href="#saveFile" 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="saveFile.saveFile-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#saveFile.saveFile-1" 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">request</span>: <a href="SaveFileRequest.html" class="tsd-signature-type tsd-kind-class">SaveFileRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to save the file.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type CreatedWithIdResponse.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>saveFile - Saves a file to a record in Onspring.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L269">models/OnspringClient.ts:269</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveRecord" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Record</span><a href="#saveRecord" 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="saveRecord.saveRecord-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Record</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#saveRecord.saveRecord-1" 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">request</span>: <a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a><span class="tsd-signature-symbol"> | </span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a></span><div class="tsd-comment tsd-typography"><p>The record or request that will be used to save the record.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:269</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveRecord" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Record</span><a href="#saveRecord" 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="saveRecord.saveRecord-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Record</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#saveRecord.saveRecord-1" 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">request</span>: <a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a><span class="tsd-signature-symbol"> | </span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a></span><div class="tsd-comment tsd-typography"><p>The record or request that will be used to save the record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A promise that resolves to an ApiResponse of type SaveRecordResponse.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>saveRecord - Saves a record.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/OnspringClient.ts#L431">models/OnspringClient.ts:431</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#_client" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_client</span></a><a href="#addOrUpdateListItem" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span></a><a href="#canConnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Connect</span></a><a href="#delete" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#deleteFileById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>File<wbr/>By<wbr/>Id</span></a><a href="#deleteListItemById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span></a><a href="#deleteRecordById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Record<wbr/>By<wbr/>Id</span></a><a href="#deleteRecordsByIds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Records<wbr/>By<wbr/>Ids</span></a><a href="#get" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</Line truncated
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:431</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#_client" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_client</span></a><a href="#addOrUpdateListItem" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span></a><a href="#canConnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Connect</span></a><a href="#delete" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#deleteFileById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>File<wbr/>By<wbr/>Id</span></a><a href="#deleteListItemById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span></a><a href="#deleteRecordById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Record<wbr/>By<wbr/>Id</span></a><a href="#deleteRecordsByIds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Records<wbr/>By<wbr/>Ids</span></a><a href="#get" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#getAppById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="PagedResponse.html">PagedResponse</a></li></ul><h1>Class PagedResponse<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>PagedResponse - A generic paged response model</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#PagedResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">PagedResponse</span><ul class="tsd-hierarchy"><li><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a></li><li><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a></li><li><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a></li><li><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a></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/PagedResponse.ts#L4">models/PagedResponse.ts:4</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="PagedResponse.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"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#PagedResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">PagedResponse</span><ul class="tsd-hierarchy"><li><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a></li><li><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a></li><li><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a></li><li><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/PagedResponse.ts:4</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="PagedResponse.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="PagedResponse.html#items" class="tsd-index-link"><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="PagedResponse.html#pageNumber" class="tsd-index-link"><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="PagedResponse.html#pageSize" class="tsd-index-link"><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="PagedResponse.html" class="tsd-signature-type tsd-kind-class">PagedResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="PagedResponse.html#constructor.new_PagedResponse.T-1">T</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A new instance of the PagedResponse class.</li>
|
||||
</ul>
|
||||
<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/PagedResponse.ts#L39">models/PagedResponse.ts:39</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="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 class="tsd-signature-type tsd-kind-type-parameter" href="PagedResponse.html#constructor.new_PagedResponse.T-1">T</a><span class="tsd-signature-symbol">[]</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/PagedResponse.ts#L8">models/PagedResponse.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><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"><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"><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"><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"><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"><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"><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"><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 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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" strLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/PagedResponse.ts:39</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="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 class="tsd-signature-type tsd-kind-type-parameter" href="PagedResponse.html#constructor.new_PagedResponse.T-1">T</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/PagedResponse.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member"><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"><ul><li>Defined in models/PagedResponse.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member"><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"><ul><li>Defined in models/PagedResponse.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member"><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"><ul><li>Defined in models/PagedResponse.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member"><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"><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inheriLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="PagingRequest.html">PagingRequest</a></li></ul><h1>Class PagingRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>PagingRequest - Paging request model</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/PagingRequest.ts#L6">models/PagingRequest.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="PagingRequest.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/PagingRequest.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="PagingRequest.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="PagingRequest.html#pageNumber" class="tsd-index-link"><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="PagingRequest.html#pageSize" class="tsd-index-link"><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>
|
||||
</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_PagingRequest" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Paging<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pageNumber</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a><a href="#constructor.new_PagingRequest" 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">pageNumber</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The page number of the request. Must be greater than 0.</p>
|
||||
@@ -171,7 +171,7 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>Thrown when the pageSize is less than 1 or greater than 1000.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/PagingRequest.ts#L25">models/PagingRequest.ts:25</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="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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/PagingRequest.ts#L10">models/PagingRequest.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/PagingRequest.ts#L15">models/PagingRequest.ts:15</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#pageNumber" class=""><svg class="tsd-kind-icon" viewBoxLine truncated
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/PagingRequest.ts:25</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="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"><ul><li>Defined in models/PagingRequest.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member"><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"><ul><li>Defined in models/PagingRequest.ts:15</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#pageNumber" class=""><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="#pageSize" class=""><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></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="QueryFilter.html">QueryFilter</a></li></ul><h1>Class QueryFilter</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>QueryFilter - Represents a query filter.</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/QueryFilter.ts#L6">models/QueryFilter.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="QueryFilter.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/QueryFilter.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="QueryFilter.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="QueryFilter.html#fieldId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a>
|
||||
<a href="QueryFilter.html#operator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>operator</span></a>
|
||||
<a href="QueryFilter.html#value" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a>
|
||||
@@ -171,11 +171,11 @@
|
||||
<div class="tsd-comment tsd-typography"><h4>Throws</h4><ul>
|
||||
<li>If the value is null and the operator is not IsNull or NotNull.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/QueryFilter.ts#L30">models/QueryFilter.ts:30</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/QueryFilter.ts#L10">models/QueryFilter.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="operator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>operator</span><a href="#operator" 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">operator</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FilterOperators.html" class="tsd-signature-type tsd-kind-enum">FilterOperators</a></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/QueryFilter.ts#L15">models/QueryFilter.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</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/QueryFilter.ts#L20">models/QueryFilter.ts:20</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" 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="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/QueryFilter.ts:30</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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"><ul><li>Defined in models/QueryFilter.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="operator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>operator</span><a href="#operator" 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">operator</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FilterOperators.html" class="tsd-signature-type tsd-kind-enum">FilterOperators</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/QueryFilter.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</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/QueryFilter.ts:20</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" 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="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The filter as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>toString - Converts the filter to a string.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/QueryFilter.ts#L52">models/QueryFilter.ts:52</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#operator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>operator</span></a><a href="#value" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/QueryFilter.ts:52</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#operator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>operator</span></a><a href="#value" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="QueryRecordsRequest.html">QueryRecordsRequest</a></li></ul><h1>Class QueryRecordsRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>QueryRecordsRequest - Request to query for records.</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/QueryRecordsRequest.ts#L8">models/QueryRecordsRequest.ts:8</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="QueryRecordsRequest.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/QueryRecordsRequest.ts:8</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="QueryRecordsRequest.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="QueryRecordsRequest.html#appId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
|
||||
<a href="QueryRecordsRequest.html#dataFormat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Format</span></a>
|
||||
<a href="QueryRecordsRequest.html#fieldIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Ids</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="QueryRecordsRequest.html" class="tsd-signature-type tsd-kind-class">QueryRecordsRequest</a></h4><ul>
|
||||
<li>A new instance of QueryRecordsRequest</li>
|
||||
</ul>
|
||||
<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/QueryRecordsRequest.ts#L43">models/QueryRecordsRequest.ts:43</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/QueryRecordsRequest.ts#L12">models/QueryRecordsRequest.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dataFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data<wbr/>Format</span><a href="#dataFormat" 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">data<wbr/>Format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a></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/QueryRecordsRequest.ts#L27">models/QueryRecordsRequest.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Ids</span><a href="#fieldIds" 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">field<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</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/QueryRecordsRequest.ts#L22">models/QueryRecordsRequest.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="filter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>filter</span><a href="#filter" 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">filter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="QueryFilter.html" class="tsd-signature-type tsd-kind-class">QueryFilter</a></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/QueryRecordsRequest.ts#L17">models/QueryRecordsRequest.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pagingRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>paging<wbr/>Request</span><a href="#pagingRequest" 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">paging<wbr/>Request</span><span class="tsd-signature-symbol">:</span> <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a></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/QueryRecordsRequest.ts#L32">models/QueryRecordsRequest.ts:32</a></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" ariLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/QueryRecordsRequest.ts:43</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in models/QueryRecordsRequest.ts:12</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dataFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data<wbr/>Format</span><a href="#dataFormat" 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">data<wbr/>Format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/QueryRecordsRequest.ts:27</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Ids</span><a href="#fieldIds" 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">field<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/QueryRecordsRequest.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="filter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>filter</span><a href="#filter" 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">filter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="QueryFilter.html" class="tsd-signature-type tsd-kind-class">QueryFilter</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/QueryRecordsRequest.ts:17</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pagingRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>paging<wbr/>Request</span><a href="#pagingRequest" 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">paging<wbr/>Request</span><span class="tsd-signature-symbol">:</span> <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/QueryRecordsRequest.ts:32</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none">Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="Record.html">Record</a></li></ul><h1>Class Record</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Record - A record in an app.</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/Record.ts#L7">models/Record.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="Record.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/Record.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="Record.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="Record.html#appId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
|
||||
<a href="Record.html#fieldData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Data</span></a>
|
||||
<a href="Record.html#recordId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a>
|
||||
@@ -170,15 +170,15 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a></h4><ul>
|
||||
<li>A new instance of Record.</li>
|
||||
</ul>
|
||||
<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/Record.ts#L30">models/Record.ts:30</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Record.ts#L11">models/Record.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Data</span><a href="#fieldData" 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">field<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</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/Record.ts#L21">models/Record.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" 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">record<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Record.ts#L16">models/Record.ts:16</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Value</span><a href="#addValue" 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="addValue.addValue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Value</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addValue.addValue-1" 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">fieldData</span>: <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The value to add to the record.</p>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:30</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in models/Record.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Data</span><a href="#fieldData" 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">field<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" 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">record<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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"><ul><li>Defined in models/Record.ts:16</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Value</span><a href="#addValue" 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="addValue.addValue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Value</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addValue.addValue-1" 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">fieldData</span>: <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The value to add to the record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Method</h4><p>addValue - Adds a value to the record.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Record.ts#L45">models/Record.ts:45</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Values</span><a href="#addValues" 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="addValues.addValues-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Values</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addValues.addValues-1" 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">fieldData</span>: <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The values to add to the record.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:45</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Values</span><a href="#addValues" 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="addValues.addValues-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Values</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addValues.addValues-1" 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">fieldData</span>: <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The values to add to the record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Method</h4><p>addValues - Adds values to the record.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Record.ts#L54">models/Record.ts:54</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="convertToSaveRecordRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span><a href="#convertToSaveRecordRequest" 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="convertToSaveRecordRequest.convertToSaveRecordRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a><a href="#convertToSaveRecordRequest.convertToSaveRecordRequest-1" 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"><h4 class="tsd-returns-title">Returns <a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:54</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="convertToSaveRecordRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span><a href="#convertToSaveRecordRequest" 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="convertToSaveRecordRequest.convertToSaveRecordRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a><a href="#convertToSaveRecordRequest.convertToSaveRecordRequest-1" 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"><h4 class="tsd-returns-title">Returns <a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a></h4><ul>
|
||||
<li>A SaveRecordRequest.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToSaveRecordRequest - Converts the record to a SaveRecordRequest.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Record.ts#L62">models/Record.ts:62</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#appId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a><a href="#fieldData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Data</span></a><a href="#recordId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a><a href="#addValue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Value</span></a><a href="#addValues" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Values</span></a><a href="#convertToSaveRecordRequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:62</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#appId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a><a href="#fieldData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Data</span></a><a href="#recordId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a><a href="#addValue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Value</span></a><a href="#addValues" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Values</span></a><a href="#convertToSaveRecordRequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="RecordValue.html">RecordValue</a></li></ul><h1>Class RecordValue<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>RecordValue - A value for a field in a record.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#RecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">RecordValue</span><ul class="tsd-hierarchy"><li><a href="AttachmentListRecordValue.html" class="tsd-signature-type tsd-kind-class">AttachmentListRecordValue</a></li><li><a href="DateRecordValue.html" class="tsd-signature-type tsd-kind-class">DateRecordValue</a></li><li><a href="DecimalRecordValue.html" class="tsd-signature-type tsd-kind-class">DecimalRecordValue</a></li><li><a href="DelegateListRecordValue.html" class="tsd-signature-type tsd-kind-class">DelegateListRecordValue</a></li><li><a href="FileListRecordValue.html" class="tsd-signature-type tsd-kind-class">FileListRecordValue</a></li><li><a href="GuidListRecordValue.html" class="tsd-signature-type tsd-kind-class">GuidListRecordValue</a></li><li><a href="GuidRecordValue.html" class="tsd-signature-type tsd-kind-class">GuidRecordValue</a></li><li><a href="IntegerListRecordValue.html" class="tsd-signature-type tsd-kind-class">IntegerListRecordValue</a></li><li><a href="IntegerRecordValue.html" class="tsd-signature-type tsd-kind-class">IntegerRecordValue</a></li><li><a href="ScoringGroupListRecordValue.html" class="tsd-signature-type tsd-kind-class">ScoringGroupListRecordValue</a></li><li><a href="StringListRecordValue.html" class="tsd-signature-type tsd-kind-class">StringListRecordValue</a></li><li><a href="StringRecordValue.html" class="tsd-signature-type tsd-kind-class">StringRecordValue</a></li><li><a href="TimeSpanRecordValue.html" class="tsd-signature-type tsd-kind-class">TimeSpanRecordValue</a></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/RecordValue.ts#L14">models/RecordValue.ts:14</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="RecordValue.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"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#RecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">RecordValue</span><ul class="tsd-hierarchy"><li><a href="AttachmentListRecordValue.html" class="tsd-signature-type tsd-kind-class">AttachmentListRecordValue</a></li><li><a href="DateRecordValue.html" class="tsd-signature-type tsd-kind-class">DateRecordValue</a></li><li><a href="DecimalRecordValue.html" class="tsd-signature-type tsd-kind-class">DecimalRecordValue</a></li><li><a href="DelegateListRecordValue.html" class="tsd-signature-type tsd-kind-class">DelegateListRecordValue</a></li><li><a href="FileListRecordValue.html" class="tsd-signature-type tsd-kind-class">FileListRecordValue</a></li><li><a href="GuidListRecordValue.html" class="tsd-signature-type tsd-kind-class">GuidListRecordValue</a></li><li><a href="GuidRecordValue.html" class="tsd-signature-type tsd-kind-class">GuidRecordValue</a></li><li><a href="IntegerListRecordValue.html" class="tsd-signature-type tsd-kind-class">IntegerListRecordValue</a></li><li><a href="IntegerRecordValue.html" class="tsd-signature-type tsd-kind-class">IntegerRecordValue</a></li><li><a href="ScoringGroupListRecordValue.html" class="tsd-signature-type tsd-kind-class">ScoringGroupListRecordValue</a></li><li><a href="StringListRecordValue.html" class="tsd-signature-type tsd-kind-class">StringListRecordValue</a></li><li><a href="StringRecordValue.html" class="tsd-signature-type tsd-kind-class">StringRecordValue</a></li><li><a href="TimeSpanRecordValue.html" class="tsd-signature-type tsd-kind-class">TimeSpanRecordValue</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:14</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="RecordValue.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="RecordValue.html#fieldId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a>
|
||||
<a href="RecordValue.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>
|
||||
<a href="RecordValue.html#value" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a>
|
||||
@@ -177,7 +177,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RecordValue.html#constructor.new_RecordValue.T-1">T</a><span class="tsd-signature-symbol">></span></h4><ul>
|
||||
<li>A new instance of RecordValue.</li>
|
||||
</ul>
|
||||
<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/RecordValue.ts#L37">models/RecordValue.ts:37</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></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/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RecordValue.html#constructor.new_RecordValue.T-1">T</a></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/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:37</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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"><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RecordValue.html#constructor.new_RecordValue.T-1">T</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -187,68 +187,68 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Type</span><a href="#validateType" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateType.validateType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">expectedTypes</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validateType.validateType-1" 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">expectedTypes</span>: <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The expected types.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Type</span><a href="#validateType" 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 tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateType.validateType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">expectedTypes</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validateType.validateType-1" 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">expectedTypes</span>: <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The expected types.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Method</h4><p>validateType - Validates the type of the field value.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the type is not valid.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L139">models/RecordValue.ts:139</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span></a><a href="#asString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icLine truncated
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/RecordValue.ts:139</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span></a><a href="#asString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>String</span></a><a href="#asStringArray" class=""><svg class="tsd-kind-icon" viewBoxLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="ReferenceField.html">ReferenceField</a></li></ul><h1>Class ReferenceField</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ReferenceField - Represents a reference field.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ReferenceField">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><ul class="tsd-hierarchy"><li><span class="target">ReferenceField</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/ReferenceField.ts#L9">models/ReferenceField.ts:9</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="ReferenceField.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#ReferenceField">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><ul class="tsd-hierarchy"><li><span class="target">ReferenceField</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/ReferenceField.ts:9</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="ReferenceField.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="ReferenceField.html#appId" 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>app<wbr/>Id</span></a>
|
||||
<a href="ReferenceField.html#id" 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>id</span></a>
|
||||
<a href="ReferenceField.html#isRequired" 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>is<wbr/>Required</span></a>
|
||||
@@ -179,7 +179,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ReferenceField.html" class="tsd-signature-type tsd-kind-class">ReferenceField</a></h4><ul>
|
||||
<li>A new ReferenceField.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ReferenceField.ts#L33">models/ReferenceField.ts:33</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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="Field.html">Field</a>.<a href="Field.html#appId">appId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L16">models/Field.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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="Field.html">Field</a>.<a href="Field.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L11">models/Field.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" 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">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isRequired">isRequired</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L36">models/Field.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" 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">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isUnique">isUnique</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L41">models/Field.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="multiplicity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>multiplicity</span><a href="#multiplicity" 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">multiplicity</span><span class="tsd-signature-symbol">:</span> <a href="../enums/Multiplicity.html" class="tsd-signature-type tsd-kind-enum">Multiplicity</a></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/ReferenceField.ts#L13">models/ReferenceField.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"Line truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p><ul><li>Defined in models/ReferenceField.ts:33</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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="Field.html">Field</a>.<a href="Field.html#appId">appId</a></p><ul><li>Defined in models/Field.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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="Field.html">Field</a>.<a href="Field.html#id">id</a></p><ul><li>Defined in models/Field.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" 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">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isRequired">isRequired</a></p><ul><li>Defined in models/Field.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" 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">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isUnique">isUnique</a></p><ul><li>Defined in models/Field.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="multiplicity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>multiplicity</span><a href="#multiplicity" 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">multiplicity</span><span class="tsd-signature-symbol">:</span> <a href="../enums/Multiplicity.html" class="tsd-signature-type tsd-kind-enum">Multiplicity</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ReferenceField.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#name">name</a></p><ul><li>Defined in models/Field.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="referencedAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>referenced<wbr/>App<wbr/>Id</span><a href="#referencedAppId" 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">referenced<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><divLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -157,12 +157,12 @@
|
||||
--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="Report.html">Report</a></li></ul><h1>Class Report</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Report - Represents a report.</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/Report.ts#L4">models/Report.ts:4</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="Report.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/Report.ts:4</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="Report.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="Report.html#appId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
|
||||
<a href="Report.html#description" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a>
|
||||
<a href="Report.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
||||
<a href="Report.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</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_Report" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Report</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Report.html" class="tsd-signature-type tsd-kind-class">Report</a><a href="#constructor.new_Report" 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">appId</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</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">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Report.html" class="tsd-signature-type tsd-kind-class">Report</a></h4><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/Report.ts#L28">models/Report.ts:28</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Report.ts#L8">models/Report.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="description" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>description</span><a href="#description" 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">description</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/Report.ts#L23">models/Report.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Report.ts#L13">models/Report.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/Report.ts#L18">models/Report.tLine 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_Report" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Report</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Report.html" class="tsd-signature-type tsd-kind-class">Report</a><a href="#constructor.new_Report" 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">appId</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</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">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Report.html" class="tsd-signature-type tsd-kind-class">Report</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Report.ts:28</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in models/Report.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="description" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>description</span><a href="#description" 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">description</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/Report.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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"><ul><li>Defined in models/Report.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/Report.ts:18</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">Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="ReportData.html">ReportData</a></li></ul><h1>Class ReportData</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ReportData - Represents the data for a report.</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/ReportData.ts#L6">models/ReportData.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="ReportData.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/ReportData.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="ReportData.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="ReportData.html#columns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>columns</span></a>
|
||||
<a href="ReportData.html#rows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rows</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_ReportData" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Report<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">columns</span>, <span class="tsd-kind-parameter">rows</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><a href="#constructor.new_ReportData" 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">columns</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The columns in the report.</p>
|
||||
@@ -165,7 +165,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a></h4><ul>
|
||||
<li>A new instance of ReportData.</li>
|
||||
</ul>
|
||||
<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/ReportData.ts#L23">models/ReportData.ts:23</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="columns" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>columns</span><a href="#columns" 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">columns</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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/ReportData.ts#L10">models/ReportData.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="rows" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rows</span><a href="#rows" 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">rows</span><span class="tsd-signature-symbol">:</span> <a href="Row.html" class="tsd-signature-type tsd-kind-class">Row</a><span class="tsd-signature-symbol">[]</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/ReportData.ts#L15">models/ReportData.ts:15</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>construLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ReportData.ts:23</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="columns" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>columns</span><a href="#columns" 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">columns</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ReportData.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="rows" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rows</span><a href="#rows" 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">rows</span><span class="tsd-signature-symbol">:</span> <a href="Row.html" class="tsd-signature-type tsd-kind-class">Row</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ReportData.ts:15</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#columns" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>columns</span></a><a href="#rows" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rows</span></a></div></details></div><div class="site-Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="Row.html">Row</a></li></ul><h1>Class Row</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Row - Represents a row of data in a report.</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/Row.ts#L4">models/Row.ts:4</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="Row.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/Row.ts:4</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="Row.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="Row.html#cells" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cells</span></a>
|
||||
<a href="Row.html#recordId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</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_Row" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Row</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">cells</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Row.html" class="tsd-signature-type tsd-kind-class">Row</a><a href="#constructor.new_Row" 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">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the row represents.</p>
|
||||
@@ -165,7 +165,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Row.html" class="tsd-signature-type tsd-kind-class">Row</a></h4><ul>
|
||||
<li>A new instance of Row.</li>
|
||||
</ul>
|
||||
<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/Row.ts#L21">models/Row.ts:21</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="cells" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cells</span><a href="#cells" 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">cells</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</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/Row.ts#L13">models/Row.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" 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">record<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Row.ts#L8">models/Row.ts:8</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#cells" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use Line truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Row.ts:21</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="cells" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cells</span><a href="#cells" 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">cells</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Row.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" 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">record<wbr/>Id</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"><ul><li>Defined in models/Row.ts:8</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#cells" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cells</span></a><a href="#recordId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="SaveFileRequest.html">SaveFileRequest</a></li></ul><h1>Class SaveFileRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>SaveFileRequest - Represents a request to save a file.</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/SaveFileRequest.ts#L7">models/SaveFileRequest.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="SaveFileRequest.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/SaveFileRequest.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="SaveFileRequest.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="SaveFileRequest.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="SaveFileRequest.html#fieldId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a>
|
||||
<a href="SaveFileRequest.html#fileName" 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/>Name</span></a>
|
||||
@@ -176,11 +176,11 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="SaveFileRequest.html" class="tsd-signature-type tsd-kind-class">SaveFileRequest</a></h4><ul>
|
||||
<li>A new SaveFileRequest.</li>
|
||||
</ul>
|
||||
<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/SaveFileRequest.ts#L54">models/SaveFileRequest.ts:54</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/SaveFileRequest.ts#L36">models/SaveFileRequest.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/SaveFileRequest.ts#L16">models/SaveFileRequest.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Name</span><a href="#fileName" 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/>Name</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/SaveFileRequest.ts#L31">models/SaveFileRequest.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileStream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Stream</span><a href="#fileStream" 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/>Stream</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readable</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/SaveFileRequest.ts#L41">models/SaveFileRequest.ts:41</a></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/>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/SaveFileRequest.ts#L26">models/SaveFileRequest.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="notes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>notes</span><a href="#notes" 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">notes</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/SaveFileRequest.ts#L21">models/SaveFileRequest.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/SaveFileRequest.ts:54</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/SaveFileRequest.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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"><ul><li>Defined in models/SaveFileRequest.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Name</span><a href="#fileName" 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/>Name</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/SaveFileRequest.ts:31</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fileStream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file<wbr/>Stream</span><a href="#fileStream" 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/>Stream</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readable</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/SaveFileRequest.ts:41</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/>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/SaveFileRequest.ts:26</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="notes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>notes</span><a href="#notes" 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">notes</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/SaveFileRequest.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" 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">record<wbr/>Id</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"><ul><li>Defined in models/SaveFileRequest.ts:11</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="asFormData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Form<wbr/>Data</span><a href="#asFormData" 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="asLine truncated
|
||||
<li>The SaveFileRequest as a FormData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>AsFormData - Converts the SaveFileRequest to a FormData object.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/SaveFileRequest.ts#L76">models/SaveFileRequest.ts:76</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#contentType" class=""><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="#fieldId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#fileName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Name</span></a><a href="#fileStream" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Stream</span></a><a href="#modifiedDate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modified<wbr/>Date</span></a><a href="#notes" class=""><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="#recordId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a><a href="#asFormData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Form<wbr/>Data</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Line truncated
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/SaveFileRequest.ts:76</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#contentType" class=""><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="#fieldId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#fileName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Name</span></a><a href="#fileStream" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Stream</span></a><a href="#modifiedDate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modified<wbr/>Date</span></a><a href="#notes" class=""><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="#recordId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a><a href="#asFormData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Form<wbr/>Data</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/"Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -156,14 +156,14 @@
|
||||
--md-sys-color-surface-container-high: #e9e7ec;
|
||||
--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="SaveRecordRequest.html">SaveRecordRequest</a></li></ul><h1>Class SaveRecordRequest</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/SaveRecordRequest.ts#L1">models/SaveRecordRequest.ts:1</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="SaveRecordRequest.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>
|
||||
</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="SaveRecordRequest.html">SaveRecordRequest</a></li></ul><h1>Class SaveRecordRequest</h1></div><aside class="tsd-sources"><ul><li>Defined in models/SaveRecordRequest.ts:1</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="SaveRecordRequest.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="SaveRecordRequest.html#appId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
|
||||
<a href="SaveRecordRequest.html#fields" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fields</span></a>
|
||||
<a href="SaveRecordRequest.html#recordId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a>
|
||||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="SaveRecordRequest.html#toJSON" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</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_SaveRecordRequest" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Save<wbr/>Record<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">fields</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a><a href="#constructor.new_SaveRecordRequest" 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">appId</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></span></li><li><span><span class="tsd-kind-parameter">fields</span>: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/SaveRecordRequest.ts#L19">models/SaveRecordRequest.ts:19</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/SaveRecordRequest.ts#L5">models/SaveRecordRequest.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fields</span><a href="#fields" 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">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>The key is the field id and the value is the value for the field.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/SaveRecordRequest.ts#L17">models/SaveRecordRequest.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" 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">record<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>If the record id is not provided a new record will be created. Otherwise, the existing record will be updated.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/SaveRecordRequest.ts#L11">models/SaveRecordRequest.ts:11</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" 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="toJSON.toJSON-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#toJSON.toJSON-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/SaveRecordRequest.ts#L29">models/SaveRecordRequest.ts:29</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#appId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a><a href="#fields" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fields</span></a><a href="#recordId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.Line 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_SaveRecordRequest" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Save<wbr/>Record<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">fields</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a><a href="#constructor.new_SaveRecordRequest" 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">appId</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></span></li><li><span><span class="tsd-kind-parameter">fields</span>: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a></h4><aside class="tsd-sources"><ul><li>Defined in models/SaveRecordRequest.ts:19</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="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" 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">app<wbr/>Id</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"><ul><li>Defined in models/SaveRecordRequest.ts:5</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fields</span><a href="#fields" 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">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>The key is the field id and the value is the value for the field.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/SaveRecordRequest.ts:17</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" 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">record<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>If the record id is not provided a new record will be created. Otherwise, the existing record will be updated.</p>
|
||||
</div><aside class="tsd-sources"><ul><li>Defined in models/SaveRecordRequest.ts:11</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" 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="toJSON.toJSON-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#toJSON.toJSON-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in models/SaveRecordRequest.ts:29</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#appId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a><a href="#fields" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fields</span></a><a href="#recordId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a><a href="#toJSON" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a></div></details></div><div class="site-meLine truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="SaveRecordResponse.html">SaveRecordResponse</a></li></ul><h1>Class SaveRecordResponse</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>SaveRecordResponse - Response from saving a record</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#SaveRecordResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">SaveRecordResponse</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/SaveRecordResponse.ts#L6">models/SaveRecordResponse.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="SaveRecordResponse.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#SaveRecordResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">SaveRecordResponse</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/SaveRecordResponse.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="SaveRecordResponse.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="SaveRecordResponse.html#id" 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>id</span></a>
|
||||
<a href="SaveRecordResponse.html#warnings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>warnings</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_SaveRecordResponse" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Save<wbr/>Record<wbr/>Response</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">warnings</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><a href="#constructor.new_SaveRecordResponse" 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">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
|
||||
@@ -165,7 +165,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a></h4><ul>
|
||||
<li>A new instance of SaveRecordResponse.s</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/SaveRecordResponse.ts#L18">models/SaveRecordResponse.ts:18</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="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/CreatedWithIdResponse.ts#L8">models/CreatedWithIdResponse.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="warnings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>warnings</span><a href="#warnings" 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">warnings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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/SaveRecordResponse.ts#L10">models/SaveRecordResponse.ts:10</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="Line truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#constructor">constructor</a></p><ul><li>Defined in models/SaveRecordResponse.ts:18</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="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id</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="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#id">id</a></p><ul><li>Defined in models/CreatedWithIdResponse.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="warnings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>warnings</span><a href="#warnings" 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">warnings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/SaveRecordResponse.ts:10</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="ScoringGroup.html">ScoringGroup</a></li></ul><h1>Class ScoringGroup</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ScoringGroup - A class that represents a scoring group.</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/ScoringGroup.ts#L4">models/ScoringGroup.ts:4</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="ScoringGroup.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/ScoringGroup.ts:4</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="ScoringGroup.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="ScoringGroup.html#listValueId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list<wbr/>Value<wbr/>Id</span></a>
|
||||
<a href="ScoringGroup.html#maximumScore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>maximum<wbr/>Score</span></a>
|
||||
<a href="ScoringGroup.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
|
||||
@@ -169,7 +169,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a></h4><ul>
|
||||
<li>A new instance of ScoringGroup.</li>
|
||||
</ul>
|
||||
<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/ScoringGroup.ts#L33">models/ScoringGroup.ts:33</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="listValueId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Value<wbr/>Id</span><a href="#listValueId" 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">list<wbr/>Value<wbr/>Id</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/ScoringGroup.ts#L8">models/ScoringGroup.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="maximumScore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>maximum<wbr/>Score</span><a href="#maximumScore" 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">maximum<wbr/>Score</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ScoringGroup.ts#L23">models/ScoringGroup.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/ScoringGroup.ts#L13">models/ScoringGroup.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="score" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>score</span><a href="#score" 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">score</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ScoringGroup.ts#L18">models/ScoringGroup.ts:18</a></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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" rLine truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ScoringGroup.ts:33</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="listValueId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Value<wbr/>Id</span><a href="#listValueId" 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">list<wbr/>Value<wbr/>Id</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/ScoringGroup.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="maximumScore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>maximum<wbr/>Score</span><a href="#maximumScore" 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">maximum<wbr/>Score</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"><ul><li>Defined in models/ScoringGroup.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</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/ScoringGroup.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="score" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>score</span><a href="#score" 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">score</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"><ul><li>Defined in models/ScoringGroup.ts:18</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 1Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="ScoringGroupListRecordValue.html">ScoringGroupListRecordValue</a></li></ul><h1>Class ScoringGroupListRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ScoringGroupListRecordValue - Represents a scoring group list record value.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ScoringGroupListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">ScoringGroupListRecordValue</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/ScoringGroupListRecordValue.ts#L8">models/ScoringGroupListRecordValue.ts:8</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="ScoringGroupListRecordValue.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#ScoringGroupListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">ScoringGroupListRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/ScoringGroupListRecordValue.ts:8</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="ScoringGroupListRecordValue.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="ScoringGroupListRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="ScoringGroupListRecordValue.html#type" 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>type</span></a>
|
||||
<a href="ScoringGroupListRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ScoringGroupListRecordValue.html" class="tsd-signature-type tsd-kind-class">ScoringGroupListRecordValue</a></h4><ul>
|
||||
<li>A new instance of ScoringGroupListRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ScoringGroupListRecordValue.ts#L15">models/ScoringGroupListRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/ScoringGroupListRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="StringListRecordValue.html">StringListRecordValue</a></li></ul><h1>Class StringListRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>StringListRecordValue - Represents a string list record value.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#StringListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">StringListRecordValue</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/StringListRecordValue.ts#L7">models/StringListRecordValue.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="StringListRecordValue.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#StringListRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">StringListRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/StringListRecordValue.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="StringListRecordValue.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="StringListRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="StringListRecordValue.html#type" 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>type</span></a>
|
||||
<a href="StringListRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="StringListRecordValue.html" class="tsd-signature-type tsd-kind-class">StringListRecordValue</a></h4><ul>
|
||||
<li>A new instance of StringListRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/StringListRecordValue.ts#L14">models/StringListRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/StringListRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="StringRecordValue.html">StringRecordValue</a></li></ul><h1>Class StringRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>StringRecordValue - A record value represented by a string.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#StringRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">StringRecordValue</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/StringRecordValue.ts#L7">models/StringRecordValue.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="StringRecordValue.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#StringRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">StringRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/StringRecordValue.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="StringRecordValue.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="StringRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="StringRecordValue.html#type" 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>type</span></a>
|
||||
<a href="StringRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="StringRecordValue.html" class="tsd-signature-type tsd-kind-class">StringRecordValue</a></h4><ul>
|
||||
<li>A new instance of StringRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/StringRecordValue.ts#L14">models/StringRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/StringRecordValue.ts:14</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</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"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -156,7 +156,7 @@
|
||||
--md-sys-color-surface-container-high: #e9e7ec;
|
||||
--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="TimeSpanData.html">TimeSpanData</a></li></ul><h1>Class TimeSpanData</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/TimeSpanData.ts#L4">models/TimeSpanData.ts:4</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="TimeSpanData.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>
|
||||
</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="TimeSpanData.html">TimeSpanData</a></li></ul><h1>Class TimeSpanData</h1></div><aside class="tsd-sources"><ul><li>Defined in models/TimeSpanData.ts:4</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="TimeSpanData.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="TimeSpanData.html#endAfterOccurrences" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>end<wbr/>After<wbr/>Occurrences</span></a>
|
||||
<a href="TimeSpanData.html#endByDate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>end<wbr/>By<wbr/>Date</span></a>
|
||||
<a href="TimeSpanData.html#increment" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>increment</span></a>
|
||||
@@ -170,7 +170,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>A new instance of TimeSpanData.</li>
|
||||
</ul>
|
||||
<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/TimeSpanData.ts#L36">models/TimeSpanData.ts:36</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="endAfterOccurrences" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end<wbr/>After<wbr/>Occurrences</span><a href="#endAfterOccurrences" 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">end<wbr/>After<wbr/>Occurrences</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/TimeSpanData.ts#L23">models/TimeSpanData.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="endByDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end<wbr/>By<wbr/>Date</span><a href="#endByDate" 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">end<wbr/>By<wbr/>Date</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/TimeSpanData.ts#L25">models/TimeSpanData.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="increment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>increment</span><a href="#increment" 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">increment</span><span class="tsd-signature-symbol">:</span> <a href="../enums/TimeSpanIncrement.html" class="tsd-signature-type tsd-kind-enum">TimeSpanIncrement</a></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/TimeSpanData.ts#L13">models/TimeSpanData.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="quantity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>quantity</span><a href="#quantity" 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">quantity</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"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/TimeSpanData.ts#L8">models/TimeSpanData.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recurrence" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>recurrence</span><a href="#recurrence" 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">recurrence</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/TimeSpanRecurrenceType.html" class="tsd-signature-type tsd-kind-enum">TimeSpanRecurrenceType</a></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/TimeSpanData.ts#L18">models/TimeSpanData.ts:18</a></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"/Line truncated
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/TimeSpanData.ts:36</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="endAfterOccurrences" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end<wbr/>After<wbr/>Occurrences</span><a href="#endAfterOccurrences" 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">end<wbr/>After<wbr/>Occurrences</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</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"><ul><li>Defined in models/TimeSpanData.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="endByDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end<wbr/>By<wbr/>Date</span><a href="#endByDate" 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">end<wbr/>By<wbr/>Date</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div><aside class="tsd-sources"><ul><li>Defined in models/TimeSpanData.ts:25</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="increment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>increment</span><a href="#increment" 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">increment</span><span class="tsd-signature-symbol">:</span> <a href="../enums/TimeSpanIncrement.html" class="tsd-signature-type tsd-kind-enum">TimeSpanIncrement</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/TimeSpanData.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="quantity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>quantity</span><a href="#quantity" 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">quantity</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"><ul><li>Defined in models/TimeSpanData.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recurrence" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>recurrence</span><a href="#recurrence" 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">recurrence</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/TimeSpanRecurrenceType.html" class="tsd-signature-type tsd-kind-enum">TimeSpanRecurrenceType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/TimeSpanData.ts:18</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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
@@ -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="TimeSpanRecordValue.html">TimeSpanRecordValue</a></li></ul><h1>Class TimeSpanRecordValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>TimeSpanRecordValue - Represents a time span record value.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#TimeSpanRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">TimeSpanRecordValue</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/TimeSpanRecordValue.ts#L8">models/TimeSpanRecordValue.ts:8</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="TimeSpanRecordValue.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#TimeSpanRecordValue">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol"><</span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">TimeSpanRecordValue</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/TimeSpanRecordValue.ts:8</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="TimeSpanRecordValue.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="TimeSpanRecordValue.html#fieldId" 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>field<wbr/>Id</span></a>
|
||||
<a href="TimeSpanRecordValue.html#type" 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>type</span></a>
|
||||
<a href="TimeSpanRecordValue.html#value" 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>value</span></a>
|
||||
@@ -175,7 +175,7 @@
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TimeSpanRecordValue.html" class="tsd-signature-type tsd-kind-class">TimeSpanRecordValue</a></h4><ul>
|
||||
<li>A new instance of TimeSpanRecordValue.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/TimeSpanRecordValue.ts#L15">models/TimeSpanRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L23">models/RecordValue.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L18">models/RecordValue.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L28">models/RecordValue.ts:28</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#constructor">constructor</a></p><ul><li>Defined in models/TimeSpanRecordValue.ts:15</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="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" 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">field<wbr/>Id</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="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#fieldId">fieldId</a></p><ul><li>Defined in models/RecordValue.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RecordValueType.html" class="tsd-signature-type tsd-kind-enum">RecordValueType</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#type">type</a></p><ul><li>Defined in models/RecordValue.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#value">value</a></p><ul><li>Defined in models/RecordValue.ts:28</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asAttachmentArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Attachment<wbr/>Array</span><a href="#asAttachmentArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asAttachmentArray.asAttachmentArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Attachment<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span><a href="#asAttachmentArray.asAttachmentArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of attachments.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAttachmentArray - Gets the value as an array of attachments.</p>
|
||||
@@ -185,63 +185,63 @@
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the storage location is not a valid FileStorageSite.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L79">models/RecordValue.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asAttachmentArray">asAttachmentArray</a></p><ul><li>Defined in models/RecordValue.ts:79</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Date</span><a href="#asDate" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDate.asDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#asDate.asDate-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><ul>
|
||||
<li>The value as a date.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDate - Gets the value as a date.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a date.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L68">models/RecordValue.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDate">asDate</a></p><ul><li>Defined in models/RecordValue.ts:68</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asDelegateArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Delegate<wbr/>Array</span><a href="#asDelegateArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asDelegateArray.asDelegateArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Delegate<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span><a href="#asDelegateArray.asDelegateArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of delegates.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asDelegateArray - Gets the value as an array of delegates.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of delegates.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L109">models/RecordValue.ts:109</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asDelegateArray">asDelegateArray</a></p><ul><li>Defined in models/RecordValue.ts:109</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number</span><a href="#asNumber" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumber.asNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asNumber.asNumber-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><ul>
|
||||
<li>The value as a number.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumber - Gets the value as a number.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a number.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L58">models/RecordValue.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumber">asNumber</a></p><ul><li>Defined in models/RecordValue.ts:58</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asNumberArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Number<wbr/>Array</span><a href="#asNumberArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asNumberArray.asNumberArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Number<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#asNumberArray.asNumberArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of numbers.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asNumberArray - Gets the value as an array of numbers.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of numbers.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L89">models/RecordValue.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asNumberArray">asNumberArray</a></p><ul><li>Defined in models/RecordValue.ts:89</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asScoringGroupArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><a href="#asScoringGroupArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asScoringGroupArray.asScoringGroupArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Scoring<wbr/>Group<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span><a href="#asScoringGroupArray.asScoringGroupArray-1" 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"><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of scoring groups.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asScoringGroupArray - Gets the value as an array of scoring groups.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of scoring groups.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L119">models/RecordValue.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asScoringGroupArray">asScoringGroupArray</a></p><ul><li>Defined in models/RecordValue.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String</span><a href="#asString" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asString.asString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#asString.asString-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
|
||||
<li>The value as a string.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asString - Gets the value as a string.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a string.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L48">models/RecordValue.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asString">asString</a></p><ul><li>Defined in models/RecordValue.ts:48</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asStringArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>String<wbr/>Array</span><a href="#asStringArray" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asStringArray.asStringArray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>String<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#asStringArray.asStringArray-1" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><ul>
|
||||
<li>The value as an array of strings.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asStringArray - Gets the value as an array of strings.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not an array of strings.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L99">models/RecordValue.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asStringArray">asStringArray</a></p><ul><li>Defined in models/RecordValue.ts:99</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="asTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#asTimeSpanData" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="asTimeSpanData.asTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#asTimeSpanData.asTimeSpanData-1" 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"><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
|
||||
<li>The value as a TimeSpanData object.</li>
|
||||
</ul>
|
||||
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asTimeSpanData - Gets the value as a TimeSpanData object.</p>
|
||||
<h4>Throws</h4><ul>
|
||||
<li>If the value is not a TimeSpanData object.</li>
|
||||
</ul>
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/RecordValue.ts#L129">models/RecordValue.ts:129</a></li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inheriLine truncated
|
||||
</div><aside class="tsd-sources"><p>Inherited from <a href="RecordValue.html">RecordValue</a>.<a href="RecordValue.html#asTimeSpanData">asTimeSpanData</a></p><ul><li>Defined in models/RecordValue.ts:129</li></ul></aside></li></ul></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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#value" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#asAttachmentArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Attachment<wbr/>Array</span></a><a href="#asDate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Date</span></a><a href="#asDelegateArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Delegate<wbr/>Array</span></a><a href="#asNumber" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number</span></a><a href="#asNumberArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Number<wbr/>Array</span></a><a href="#asScoringGroupArray" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
Reference in new issue
Block a user