189 lines
23 KiB
HTML
189 lines
23 KiB
HTML
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ListItemRequest | 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="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></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>
|
||
|
|
<a href="ListItemRequest.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>
|
||
|
|
<a href="ListItemRequest.html#numericValue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>numeric<wbr/>Value</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_ListItemRequest" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>List<wbr/>Item<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listId</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">numericValue</span>, <span class="tsd-kind-parameter">color</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ListItemRequest.html" class="tsd-signature-type tsd-kind-class">ListItemRequest</a><a href="#constructor.new_ListItemRequest" aria-label="Permalink" class="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 for the list that the item belongs to.</p>
|
||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id for the list item.</p>
|
||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the list item.</p>
|
||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">numericValue</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 numeric value of the list item.</p>
|
||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">color</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The color of the list item.</p>
|
||
|
|
</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/o
|
||
|
|
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>
|