chore: add typedoc and use to generate updated documenation when publishing
This commit is contained in:
Stevan Freeborn
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,181 @@
|
||||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreatedWithIdResponse | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--md-sys-color-primary: #adc6ff;
|
||||
--md-sys-color-on-primary: #002e6a;
|
||||
--md-sys-color-primary-container: #10448f;
|
||||
--md-sys-color-on-primary-container: #d8e2ff;
|
||||
--md-sys-color-secondary: #bfc6dc;
|
||||
--md-sys-color-on-secondary: #293041;
|
||||
--md-sys-color-secondary-container: #3f4759;
|
||||
--md-sys-color-on-secondary-container: #dbe2f9;
|
||||
--md-sys-color-tertiary: #debcdf;
|
||||
--md-sys-color-on-tertiary: #402843;
|
||||
--md-sys-color-tertiary-container: #583e5b;
|
||||
--md-sys-color-on-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-error: #ffb4ab;
|
||||
--md-sys-color-on-error: #690005;
|
||||
--md-sys-color-error-container: #93000a;
|
||||
--md-sys-color-on-error-container: #ffb4ab;
|
||||
--md-sys-color-background: #1b1b1f;
|
||||
--md-sys-color-on-background: #e3e2e6;
|
||||
--md-sys-color-surface: #1b1b1f;
|
||||
--md-sys-color-on-surface: #e3e2e6;
|
||||
--md-sys-color-surface-variant: #44474f;
|
||||
--md-sys-color-on-surface-variant: #c4c6d0;
|
||||
--md-sys-color-outline: #8e9099;
|
||||
--md-sys-color-outline-variant: #44474f;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #e3e2e6;
|
||||
--md-sys-color-inverse-on-surface: #303034;
|
||||
--md-sys-color-inverse-primary: #325da8;
|
||||
--md-sys-color-surface-dim: #121316;
|
||||
--md-sys-color-surface-bright: #38393c;
|
||||
--md-sys-color-surface-container-lowest: #0d0e11;
|
||||
--md-sys-color-surface-container-low: #1b1b1f;
|
||||
--md-sys-color-surface-container: #1f1f23;
|
||||
--md-sys-color-surface-container-high: #292a2d;
|
||||
--md-sys-color-surface-container-highest: #343538
|
||||
}
|
||||
}
|
||||
:root[data-theme="dark"] {
|
||||
--md-sys-color-primary: #adc6ff;
|
||||
--md-sys-color-on-primary: #002e6a;
|
||||
--md-sys-color-primary-container: #10448f;
|
||||
--md-sys-color-on-primary-container: #d8e2ff;
|
||||
--md-sys-color-secondary: #bfc6dc;
|
||||
--md-sys-color-on-secondary: #293041;
|
||||
--md-sys-color-secondary-container: #3f4759;
|
||||
--md-sys-color-on-secondary-container: #dbe2f9;
|
||||
--md-sys-color-tertiary: #debcdf;
|
||||
--md-sys-color-on-tertiary: #402843;
|
||||
--md-sys-color-tertiary-container: #583e5b;
|
||||
--md-sys-color-on-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-error: #ffb4ab;
|
||||
--md-sys-color-on-error: #690005;
|
||||
--md-sys-color-error-container: #93000a;
|
||||
--md-sys-color-on-error-container: #ffb4ab;
|
||||
--md-sys-color-background: #1b1b1f;
|
||||
--md-sys-color-on-background: #e3e2e6;
|
||||
--md-sys-color-surface: #1b1b1f;
|
||||
--md-sys-color-on-surface: #e3e2e6;
|
||||
--md-sys-color-surface-variant: #44474f;
|
||||
--md-sys-color-on-surface-variant: #c4c6d0;
|
||||
--md-sys-color-outline: #8e9099;
|
||||
--md-sys-color-outline-variant: #44474f;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #e3e2e6;
|
||||
--md-sys-color-inverse-on-surface: #303034;
|
||||
--md-sys-color-inverse-primary: #325da8;
|
||||
--md-sys-color-surface-dim: #121316;
|
||||
--md-sys-color-surface-bright: #38393c;
|
||||
--md-sys-color-surface-container-lowest: #0d0e11;
|
||||
--md-sys-color-surface-container-low: #1b1b1f;
|
||||
--md-sys-color-surface-container: #1f1f23;
|
||||
--md-sys-color-surface-container-high: #292a2d;
|
||||
--md-sys-color-surface-container-highest: #343538
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) {
|
||||
:root {
|
||||
--md-sys-color-primary: #325da8;
|
||||
--md-sys-color-on-primary: #ffffff;
|
||||
--md-sys-color-primary-container: #d8e2ff;
|
||||
--md-sys-color-on-primary-container: #001a42;
|
||||
--md-sys-color-secondary: #575e71;
|
||||
--md-sys-color-on-secondary: #ffffff;
|
||||
--md-sys-color-secondary-container: #dbe2f9;
|
||||
--md-sys-color-on-secondary-container: #141b2c;
|
||||
--md-sys-color-tertiary: #715573;
|
||||
--md-sys-color-on-tertiary: #ffffff;
|
||||
--md-sys-color-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-on-tertiary-container: #29132d;
|
||||
--md-sys-color-error: #ba1a1a;
|
||||
--md-sys-color-on-error: #ffffff;
|
||||
--md-sys-color-error-container: #ffdad6;
|
||||
--md-sys-color-on-error-container: #410002;
|
||||
--md-sys-color-background: #fefbff;
|
||||
--md-sys-color-on-background: #1b1b1f;
|
||||
--md-sys-color-surface: #fefbff;
|
||||
--md-sys-color-on-surface: #1b1b1f;
|
||||
--md-sys-color-surface-variant: #e1e2ec;
|
||||
--md-sys-color-on-surface-variant: #44474f;
|
||||
--md-sys-color-outline: #75777f;
|
||||
--md-sys-color-outline-variant: #c4c6d0;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #303034;
|
||||
--md-sys-color-inverse-on-surface: #f2f0f4;
|
||||
--md-sys-color-inverse-primary: #adc6ff;
|
||||
--md-sys-color-surface-dim: #dbd9dd;
|
||||
--md-sys-color-surface-bright: #faf8fd;
|
||||
--md-sys-color-surface-container-lowest: #ffffff;
|
||||
--md-sys-color-surface-container-low: #f5f3f7;
|
||||
--md-sys-color-surface-container: #efedf1;
|
||||
--md-sys-color-surface-container-high: #e9e7ec;
|
||||
--md-sys-color-surface-container-highest: #e3e2e6
|
||||
}
|
||||
}
|
||||
:root[data-theme="light"] {
|
||||
--md-sys-color-primary: #325da8;
|
||||
--md-sys-color-on-primary: #ffffff;
|
||||
--md-sys-color-primary-container: #d8e2ff;
|
||||
--md-sys-color-on-primary-container: #001a42;
|
||||
--md-sys-color-secondary: #575e71;
|
||||
--md-sys-color-on-secondary: #ffffff;
|
||||
--md-sys-color-secondary-container: #dbe2f9;
|
||||
--md-sys-color-on-secondary-container: #141b2c;
|
||||
--md-sys-color-tertiary: #715573;
|
||||
--md-sys-color-on-tertiary: #ffffff;
|
||||
--md-sys-color-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-on-tertiary-container: #29132d;
|
||||
--md-sys-color-error: #ba1a1a;
|
||||
--md-sys-color-on-error: #ffffff;
|
||||
--md-sys-color-error-container: #ffdad6;
|
||||
--md-sys-color-on-error-container: #410002;
|
||||
--md-sys-color-background: #fefbff;
|
||||
--md-sys-color-on-background: #1b1b1f;
|
||||
--md-sys-color-surface: #fefbff;
|
||||
--md-sys-color-on-surface: #1b1b1f;
|
||||
--md-sys-color-surface-variant: #e1e2ec;
|
||||
--md-sys-color-on-surface-variant: #44474f;
|
||||
--md-sys-color-outline: #75777f;
|
||||
--md-sys-color-outline-variant: #c4c6d0;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #303034;
|
||||
--md-sys-color-inverse-on-surface: #f2f0f4;
|
||||
--md-sys-color-inverse-primary: #adc6ff;
|
||||
--md-sys-color-surface-dim: #dbd9dd;
|
||||
--md-sys-color-surface-bright: #faf8fd;
|
||||
--md-sys-color-surface-container-lowest: #ffffff;
|
||||
--md-sys-color-surface-container-low: #f5f3f7;
|
||||
--md-sys-color-surface-container: #efedf1;
|
||||
--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="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></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>
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
Object.assign(link, {
|
||||
href: "https://github.com/dmnsgn/typedoc-material-theme",
|
||||
target: "_blank",
|
||||
rel: "noreferrer",
|
||||
innerText: "typedoc-material-theme."
|
||||
});
|
||||
generateLinkElement.insertAdjacentElement("afterend", link);
|
||||
generateLinkElement.insertAdjacentText("afterend", " with ");
|
||||
} catch (error) {
|
||||
|
||||
}
|
||||
</script></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,193 @@
|
||||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueryFilter | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--md-sys-color-primary: #adc6ff;
|
||||
--md-sys-color-on-primary: #002e6a;
|
||||
--md-sys-color-primary-container: #10448f;
|
||||
--md-sys-color-on-primary-container: #d8e2ff;
|
||||
--md-sys-color-secondary: #bfc6dc;
|
||||
--md-sys-color-on-secondary: #293041;
|
||||
--md-sys-color-secondary-container: #3f4759;
|
||||
--md-sys-color-on-secondary-container: #dbe2f9;
|
||||
--md-sys-color-tertiary: #debcdf;
|
||||
--md-sys-color-on-tertiary: #402843;
|
||||
--md-sys-color-tertiary-container: #583e5b;
|
||||
--md-sys-color-on-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-error: #ffb4ab;
|
||||
--md-sys-color-on-error: #690005;
|
||||
--md-sys-color-error-container: #93000a;
|
||||
--md-sys-color-on-error-container: #ffb4ab;
|
||||
--md-sys-color-background: #1b1b1f;
|
||||
--md-sys-color-on-background: #e3e2e6;
|
||||
--md-sys-color-surface: #1b1b1f;
|
||||
--md-sys-color-on-surface: #e3e2e6;
|
||||
--md-sys-color-surface-variant: #44474f;
|
||||
--md-sys-color-on-surface-variant: #c4c6d0;
|
||||
--md-sys-color-outline: #8e9099;
|
||||
--md-sys-color-outline-variant: #44474f;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #e3e2e6;
|
||||
--md-sys-color-inverse-on-surface: #303034;
|
||||
--md-sys-color-inverse-primary: #325da8;
|
||||
--md-sys-color-surface-dim: #121316;
|
||||
--md-sys-color-surface-bright: #38393c;
|
||||
--md-sys-color-surface-container-lowest: #0d0e11;
|
||||
--md-sys-color-surface-container-low: #1b1b1f;
|
||||
--md-sys-color-surface-container: #1f1f23;
|
||||
--md-sys-color-surface-container-high: #292a2d;
|
||||
--md-sys-color-surface-container-highest: #343538
|
||||
}
|
||||
}
|
||||
:root[data-theme="dark"] {
|
||||
--md-sys-color-primary: #adc6ff;
|
||||
--md-sys-color-on-primary: #002e6a;
|
||||
--md-sys-color-primary-container: #10448f;
|
||||
--md-sys-color-on-primary-container: #d8e2ff;
|
||||
--md-sys-color-secondary: #bfc6dc;
|
||||
--md-sys-color-on-secondary: #293041;
|
||||
--md-sys-color-secondary-container: #3f4759;
|
||||
--md-sys-color-on-secondary-container: #dbe2f9;
|
||||
--md-sys-color-tertiary: #debcdf;
|
||||
--md-sys-color-on-tertiary: #402843;
|
||||
--md-sys-color-tertiary-container: #583e5b;
|
||||
--md-sys-color-on-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-error: #ffb4ab;
|
||||
--md-sys-color-on-error: #690005;
|
||||
--md-sys-color-error-container: #93000a;
|
||||
--md-sys-color-on-error-container: #ffb4ab;
|
||||
--md-sys-color-background: #1b1b1f;
|
||||
--md-sys-color-on-background: #e3e2e6;
|
||||
--md-sys-color-surface: #1b1b1f;
|
||||
--md-sys-color-on-surface: #e3e2e6;
|
||||
--md-sys-color-surface-variant: #44474f;
|
||||
--md-sys-color-on-surface-variant: #c4c6d0;
|
||||
--md-sys-color-outline: #8e9099;
|
||||
--md-sys-color-outline-variant: #44474f;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #e3e2e6;
|
||||
--md-sys-color-inverse-on-surface: #303034;
|
||||
--md-sys-color-inverse-primary: #325da8;
|
||||
--md-sys-color-surface-dim: #121316;
|
||||
--md-sys-color-surface-bright: #38393c;
|
||||
--md-sys-color-surface-container-lowest: #0d0e11;
|
||||
--md-sys-color-surface-container-low: #1b1b1f;
|
||||
--md-sys-color-surface-container: #1f1f23;
|
||||
--md-sys-color-surface-container-high: #292a2d;
|
||||
--md-sys-color-surface-container-highest: #343538
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) {
|
||||
:root {
|
||||
--md-sys-color-primary: #325da8;
|
||||
--md-sys-color-on-primary: #ffffff;
|
||||
--md-sys-color-primary-container: #d8e2ff;
|
||||
--md-sys-color-on-primary-container: #001a42;
|
||||
--md-sys-color-secondary: #575e71;
|
||||
--md-sys-color-on-secondary: #ffffff;
|
||||
--md-sys-color-secondary-container: #dbe2f9;
|
||||
--md-sys-color-on-secondary-container: #141b2c;
|
||||
--md-sys-color-tertiary: #715573;
|
||||
--md-sys-color-on-tertiary: #ffffff;
|
||||
--md-sys-color-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-on-tertiary-container: #29132d;
|
||||
--md-sys-color-error: #ba1a1a;
|
||||
--md-sys-color-on-error: #ffffff;
|
||||
--md-sys-color-error-container: #ffdad6;
|
||||
--md-sys-color-on-error-container: #410002;
|
||||
--md-sys-color-background: #fefbff;
|
||||
--md-sys-color-on-background: #1b1b1f;
|
||||
--md-sys-color-surface: #fefbff;
|
||||
--md-sys-color-on-surface: #1b1b1f;
|
||||
--md-sys-color-surface-variant: #e1e2ec;
|
||||
--md-sys-color-on-surface-variant: #44474f;
|
||||
--md-sys-color-outline: #75777f;
|
||||
--md-sys-color-outline-variant: #c4c6d0;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #303034;
|
||||
--md-sys-color-inverse-on-surface: #f2f0f4;
|
||||
--md-sys-color-inverse-primary: #adc6ff;
|
||||
--md-sys-color-surface-dim: #dbd9dd;
|
||||
--md-sys-color-surface-bright: #faf8fd;
|
||||
--md-sys-color-surface-container-lowest: #ffffff;
|
||||
--md-sys-color-surface-container-low: #f5f3f7;
|
||||
--md-sys-color-surface-container: #efedf1;
|
||||
--md-sys-color-surface-container-high: #e9e7ec;
|
||||
--md-sys-color-surface-container-highest: #e3e2e6
|
||||
}
|
||||
}
|
||||
:root[data-theme="light"] {
|
||||
--md-sys-color-primary: #325da8;
|
||||
--md-sys-color-on-primary: #ffffff;
|
||||
--md-sys-color-primary-container: #d8e2ff;
|
||||
--md-sys-color-on-primary-container: #001a42;
|
||||
--md-sys-color-secondary: #575e71;
|
||||
--md-sys-color-on-secondary: #ffffff;
|
||||
--md-sys-color-secondary-container: #dbe2f9;
|
||||
--md-sys-color-on-secondary-container: #141b2c;
|
||||
--md-sys-color-tertiary: #715573;
|
||||
--md-sys-color-on-tertiary: #ffffff;
|
||||
--md-sys-color-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-on-tertiary-container: #29132d;
|
||||
--md-sys-color-error: #ba1a1a;
|
||||
--md-sys-color-on-error: #ffffff;
|
||||
--md-sys-color-error-container: #ffdad6;
|
||||
--md-sys-color-on-error-container: #410002;
|
||||
--md-sys-color-background: #fefbff;
|
||||
--md-sys-color-on-background: #1b1b1f;
|
||||
--md-sys-color-surface: #fefbff;
|
||||
--md-sys-color-on-surface: #1b1b1f;
|
||||
--md-sys-color-surface-variant: #e1e2ec;
|
||||
--md-sys-color-on-surface-variant: #44474f;
|
||||
--md-sys-color-outline: #75777f;
|
||||
--md-sys-color-outline-variant: #c4c6d0;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #303034;
|
||||
--md-sys-color-inverse-on-surface: #f2f0f4;
|
||||
--md-sys-color-inverse-primary: #adc6ff;
|
||||
--md-sys-color-surface-dim: #dbd9dd;
|
||||
--md-sys-color-surface-bright: #faf8fd;
|
||||
--md-sys-color-surface-container-lowest: #ffffff;
|
||||
--md-sys-color-surface-container-low: #f5f3f7;
|
||||
--md-sys-color-surface-container: #efedf1;
|
||||
--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="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></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>
|
||||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="QueryFilter.html#toString" class="tsd-index-link"><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></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_QueryFilter" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Query<wbr/>Filter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">operator</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="QueryFilter.html" class="tsd-signature-type tsd-kind-class">QueryFilter</a><a href="#constructor.new_QueryFilter" aria-label="Permalink" class="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 filter on.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">operator</span>: <a href="../enums/FilterOperators.html" class="tsd-signature-type tsd-kind-enum">FilterOperators</a></span><div class="tsd-comment tsd-typography"><p>The operator for the filter.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</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></span><div class="tsd-comment tsd-typography"><p>The value for the filter.</p>
|
||||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="QueryFilter.html" class="tsd-signature-type tsd-kind-class">QueryFilter</a></h4><ul>
|
||||
<li>A new instance of the QueryFilter class.</li>
|
||||
</ul>
|
||||
<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>
|
||||
<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>
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
Object.assign(link, {
|
||||
href: "https://github.com/dmnsgn/typedoc-material-theme",
|
||||
target: "_blank",
|
||||
rel: "noreferrer",
|
||||
innerText: "typedoc-material-theme."
|
||||
});
|
||||
generateLinkElement.insertAdjacentElement("afterend", link);
|
||||
generateLinkElement.insertAdjacentText("afterend", " with ");
|
||||
} catch (error) {
|
||||
|
||||
}
|
||||
</script></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,196 @@
|
||||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Record | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--md-sys-color-primary: #adc6ff;
|
||||
--md-sys-color-on-primary: #002e6a;
|
||||
--md-sys-color-primary-container: #10448f;
|
||||
--md-sys-color-on-primary-container: #d8e2ff;
|
||||
--md-sys-color-secondary: #bfc6dc;
|
||||
--md-sys-color-on-secondary: #293041;
|
||||
--md-sys-color-secondary-container: #3f4759;
|
||||
--md-sys-color-on-secondary-container: #dbe2f9;
|
||||
--md-sys-color-tertiary: #debcdf;
|
||||
--md-sys-color-on-tertiary: #402843;
|
||||
--md-sys-color-tertiary-container: #583e5b;
|
||||
--md-sys-color-on-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-error: #ffb4ab;
|
||||
--md-sys-color-on-error: #690005;
|
||||
--md-sys-color-error-container: #93000a;
|
||||
--md-sys-color-on-error-container: #ffb4ab;
|
||||
--md-sys-color-background: #1b1b1f;
|
||||
--md-sys-color-on-background: #e3e2e6;
|
||||
--md-sys-color-surface: #1b1b1f;
|
||||
--md-sys-color-on-surface: #e3e2e6;
|
||||
--md-sys-color-surface-variant: #44474f;
|
||||
--md-sys-color-on-surface-variant: #c4c6d0;
|
||||
--md-sys-color-outline: #8e9099;
|
||||
--md-sys-color-outline-variant: #44474f;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #e3e2e6;
|
||||
--md-sys-color-inverse-on-surface: #303034;
|
||||
--md-sys-color-inverse-primary: #325da8;
|
||||
--md-sys-color-surface-dim: #121316;
|
||||
--md-sys-color-surface-bright: #38393c;
|
||||
--md-sys-color-surface-container-lowest: #0d0e11;
|
||||
--md-sys-color-surface-container-low: #1b1b1f;
|
||||
--md-sys-color-surface-container: #1f1f23;
|
||||
--md-sys-color-surface-container-high: #292a2d;
|
||||
--md-sys-color-surface-container-highest: #343538
|
||||
}
|
||||
}
|
||||
:root[data-theme="dark"] {
|
||||
--md-sys-color-primary: #adc6ff;
|
||||
--md-sys-color-on-primary: #002e6a;
|
||||
--md-sys-color-primary-container: #10448f;
|
||||
--md-sys-color-on-primary-container: #d8e2ff;
|
||||
--md-sys-color-secondary: #bfc6dc;
|
||||
--md-sys-color-on-secondary: #293041;
|
||||
--md-sys-color-secondary-container: #3f4759;
|
||||
--md-sys-color-on-secondary-container: #dbe2f9;
|
||||
--md-sys-color-tertiary: #debcdf;
|
||||
--md-sys-color-on-tertiary: #402843;
|
||||
--md-sys-color-tertiary-container: #583e5b;
|
||||
--md-sys-color-on-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-error: #ffb4ab;
|
||||
--md-sys-color-on-error: #690005;
|
||||
--md-sys-color-error-container: #93000a;
|
||||
--md-sys-color-on-error-container: #ffb4ab;
|
||||
--md-sys-color-background: #1b1b1f;
|
||||
--md-sys-color-on-background: #e3e2e6;
|
||||
--md-sys-color-surface: #1b1b1f;
|
||||
--md-sys-color-on-surface: #e3e2e6;
|
||||
--md-sys-color-surface-variant: #44474f;
|
||||
--md-sys-color-on-surface-variant: #c4c6d0;
|
||||
--md-sys-color-outline: #8e9099;
|
||||
--md-sys-color-outline-variant: #44474f;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #e3e2e6;
|
||||
--md-sys-color-inverse-on-surface: #303034;
|
||||
--md-sys-color-inverse-primary: #325da8;
|
||||
--md-sys-color-surface-dim: #121316;
|
||||
--md-sys-color-surface-bright: #38393c;
|
||||
--md-sys-color-surface-container-lowest: #0d0e11;
|
||||
--md-sys-color-surface-container-low: #1b1b1f;
|
||||
--md-sys-color-surface-container: #1f1f23;
|
||||
--md-sys-color-surface-container-high: #292a2d;
|
||||
--md-sys-color-surface-container-highest: #343538
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) {
|
||||
:root {
|
||||
--md-sys-color-primary: #325da8;
|
||||
--md-sys-color-on-primary: #ffffff;
|
||||
--md-sys-color-primary-container: #d8e2ff;
|
||||
--md-sys-color-on-primary-container: #001a42;
|
||||
--md-sys-color-secondary: #575e71;
|
||||
--md-sys-color-on-secondary: #ffffff;
|
||||
--md-sys-color-secondary-container: #dbe2f9;
|
||||
--md-sys-color-on-secondary-container: #141b2c;
|
||||
--md-sys-color-tertiary: #715573;
|
||||
--md-sys-color-on-tertiary: #ffffff;
|
||||
--md-sys-color-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-on-tertiary-container: #29132d;
|
||||
--md-sys-color-error: #ba1a1a;
|
||||
--md-sys-color-on-error: #ffffff;
|
||||
--md-sys-color-error-container: #ffdad6;
|
||||
--md-sys-color-on-error-container: #410002;
|
||||
--md-sys-color-background: #fefbff;
|
||||
--md-sys-color-on-background: #1b1b1f;
|
||||
--md-sys-color-surface: #fefbff;
|
||||
--md-sys-color-on-surface: #1b1b1f;
|
||||
--md-sys-color-surface-variant: #e1e2ec;
|
||||
--md-sys-color-on-surface-variant: #44474f;
|
||||
--md-sys-color-outline: #75777f;
|
||||
--md-sys-color-outline-variant: #c4c6d0;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #303034;
|
||||
--md-sys-color-inverse-on-surface: #f2f0f4;
|
||||
--md-sys-color-inverse-primary: #adc6ff;
|
||||
--md-sys-color-surface-dim: #dbd9dd;
|
||||
--md-sys-color-surface-bright: #faf8fd;
|
||||
--md-sys-color-surface-container-lowest: #ffffff;
|
||||
--md-sys-color-surface-container-low: #f5f3f7;
|
||||
--md-sys-color-surface-container: #efedf1;
|
||||
--md-sys-color-surface-container-high: #e9e7ec;
|
||||
--md-sys-color-surface-container-highest: #e3e2e6
|
||||
}
|
||||
}
|
||||
:root[data-theme="light"] {
|
||||
--md-sys-color-primary: #325da8;
|
||||
--md-sys-color-on-primary: #ffffff;
|
||||
--md-sys-color-primary-container: #d8e2ff;
|
||||
--md-sys-color-on-primary-container: #001a42;
|
||||
--md-sys-color-secondary: #575e71;
|
||||
--md-sys-color-on-secondary: #ffffff;
|
||||
--md-sys-color-secondary-container: #dbe2f9;
|
||||
--md-sys-color-on-secondary-container: #141b2c;
|
||||
--md-sys-color-tertiary: #715573;
|
||||
--md-sys-color-on-tertiary: #ffffff;
|
||||
--md-sys-color-tertiary-container: #fcd7fb;
|
||||
--md-sys-color-on-tertiary-container: #29132d;
|
||||
--md-sys-color-error: #ba1a1a;
|
||||
--md-sys-color-on-error: #ffffff;
|
||||
--md-sys-color-error-container: #ffdad6;
|
||||
--md-sys-color-on-error-container: #410002;
|
||||
--md-sys-color-background: #fefbff;
|
||||
--md-sys-color-on-background: #1b1b1f;
|
||||
--md-sys-color-surface: #fefbff;
|
||||
--md-sys-color-on-surface: #1b1b1f;
|
||||
--md-sys-color-surface-variant: #e1e2ec;
|
||||
--md-sys-color-on-surface-variant: #44474f;
|
||||
--md-sys-color-outline: #75777f;
|
||||
--md-sys-color-outline-variant: #c4c6d0;
|
||||
--md-sys-color-shadow: #000000;
|
||||
--md-sys-color-scrim: #000000;
|
||||
--md-sys-color-inverse-surface: #303034;
|
||||
--md-sys-color-inverse-on-surface: #f2f0f4;
|
||||
--md-sys-color-inverse-primary: #adc6ff;
|
||||
--md-sys-color-surface-dim: #dbd9dd;
|
||||
--md-sys-color-surface-bright: #faf8fd;
|
||||
--md-sys-color-surface-container-lowest: #ffffff;
|
||||
--md-sys-color-surface-container-low: #f5f3f7;
|
||||
--md-sys-color-surface-container: #efedf1;
|
||||
--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="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></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>
|
||||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Record.html#addValue" 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/>Value</span></a>
|
||||
<a href="Record.html#addValues" 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/>Values</span></a>
|
||||
<a href="Record.html#convertToSaveRecordRequest" class="tsd-index-link"><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></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_Record" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Record</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldData</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><a href="#constructor.new_Record" aria-label="Permalink" class="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">null</span><span class="tsd-signature-symbol"> | </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">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 class="tsd-signature-symbol"> = []</span></span><div class="tsd-comment tsd-typography"><p>The data for the fields in the record.</p>
|
||||
</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><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><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>
|
||||
<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>
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
Object.assign(link, {
|
||||
href: "https://github.com/dmnsgn/typedoc-material-theme",
|
||||
target: "_blank",
|
||||
rel: "noreferrer",
|
||||
innerText: "typedoc-material-theme."
|
||||
});
|
||||
generateLinkElement.insertAdjacentElement("afterend", link);
|
||||
generateLinkElement.insertAdjacentText("afterend", " with ");
|
||||
} catch (error) {
|
||||
|
||||
}
|
||||
</script></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user