cla-wrapper

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>CoreObject | cla-wrapper</title> <meta name="description" content="Documentation for cla-wrapper"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </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">cla-wrapper</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">cla-wrapper</a> </li> <li> <a href="../modules/claWrapper.html">claWrapper</a> </li> <li> <a href="claWrapper.CoreObject.html">CoreObject</a> </li> </ul> <h1>Class CoreObject</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">CoreObject</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="claWrapper.CoreObject.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.CoreObject.html#apiKey" class="tsd-kind-icon">api<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.CoreObject.html#baseUrl" class="tsd-kind-icon">base<wbr>Url</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.CoreObject.html#cache" class="tsd-kind-icon">cache</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.CoreObject.html#contentEncoding" class="tsd-kind-icon">content<wbr>Encoding</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.CoreObject.html#nciSiteUrl" class="tsd-kind-icon">nci<wbr>Site<wbr>Url</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.CoreObject.html#traffic" class="tsd-kind-icon">traffic</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.CoreObject.html#useNciSiteForCt" class="tsd-kind-icon">use<wbr>Nci<wbr>Site<wbr>For<wbr>Ct</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="claWrapper.CoreObject.html#apiRequest" class="tsd-kind-icon">api<wbr>Request</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Core<wbr>Object<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CoreObjectParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="claWrapper.CoreObject.html" class="tsd-signature-type" data-tsd-kind="Class">CoreObject</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L67">claWrapper.ts:67</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-type">CoreObjectParameters</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="claWrapper.CoreObject.html" class="tsd-signature-type" data-tsd-kind="Class">CoreObject</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="apiKey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> api<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">api<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L53">claWrapper.ts:53</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>CDISC Library API primary key. Used in case of OAuth2 Authentication.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="baseUrl" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> base<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">base<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L55">claWrapper.ts:55</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A base URL for the library.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="cache" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> cache</h3> <div class="tsd-signature tsd-kind-icon">cache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClCache</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L57">claWrapper.ts:57</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>apirequestoptions</dt> <dd></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="contentEncoding" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> content<wbr>Encoding</h3> <div class="tsd-signature tsd-kind-icon">content<wbr>Encoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ContentEncoding</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L65">claWrapper.ts:65</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Add Content-Encoding to request headers. See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding">https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="nciSiteUrl" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> nci<wbr>Site<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">nci<wbr>Site<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L63">claWrapper.ts:63</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>NCI site URL</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="traffic" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> traffic</h3> <div class="tsd-signature tsd-kind-icon">traffic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Traffic</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L59">claWrapper.ts:59</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>traffic</dt> <dd></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="useNciSiteForCt" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr>Nci<wbr>Site<wbr>For<wbr>Ct</h3> <div class="tsd-signature tsd-kind-icon">use<wbr>Nci<wbr>Site<wbr>For<wbr>Ct<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L61">claWrapper.ts:61</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>If true, CT is downloaded from NCI site.</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="apiRequest" class="tsd-anchor"></a> <h3>api<wbr>Request</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">api<wbr>Request<span class="tsd-signature-symbol">(</span>endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ApiRequestOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L100">claWrapper.ts:100</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Make an API request</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>endpoint: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>CDISC Library API endpoint.</p> </div> </li> <li> <h5>__namedParameters: <span class="tsd-signature-type">ApiRequestOptions</span><span class="tsd-signature-symbol"> = {}</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Request options {@link ApiRequestOptions}.</p> </div> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> <p>API response, if API request failed a blank object is returned.</p> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="../modules.html">Modules</a> </li> <li class="current tsd-kind-module"> <a href="../modules/claWrapper.html">cla<wbr>Wrapper</a> </li> <li class=" tsd-kind-module"> <a href="../modules/searchResponse.html">search<wbr>Response</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.AnalysisVariableSet.html" class="tsd-kind-icon">Analysis<wbr>Variable<wbr>Set</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.CdiscLibrary.html" class="tsd-kind-icon">Cdisc<wbr>Library</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.CodeList.html" class="tsd-kind-icon">Code<wbr>List</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.CoreObject.html" class="tsd-kind-icon">Core<wbr>Object</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="claWrapper.CoreObject.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="claWrapper.CoreObject.html#apiKey" class="tsd-kind-icon">api<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="claWrapper.CoreObject.html#baseUrl" class="tsd-kind-icon">base<wbr>Url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="claWrapper.CoreObject.html#cache" class="tsd-kind-icon">cache</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="claWrapper.CoreObject.html#contentEncoding" class="tsd-kind-icon">content<wbr>Encoding</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="claWrapper.CoreObject.html#nciSiteUrl" class="tsd-kind-icon">nci<wbr>Site<wbr>Url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="claWrapper.CoreObject.html#traffic" class="tsd-kind-icon">traffic</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="claWrapper.CoreObject.html#useNciSiteForCt" class="tsd-kind-icon">use<wbr>Nci<wbr>Site<wbr>For<wbr>Ct</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="claWrapper.CoreObject.html#apiRequest" class="tsd-kind-icon">api<wbr>Request</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.DataClass.html" class="tsd-kind-icon">Data<wbr>Class</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.DataStructure.html" class="tsd-kind-icon">Data<wbr>Structure</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.Dataset.html" class="tsd-kind-icon">Dataset</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.Domain.html" class="tsd-kind-icon">Domain</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.Field.html" class="tsd-kind-icon">Field</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.Product.html" class="tsd-kind-icon">Product</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.ProductClass.html" class="tsd-kind-icon">Product<wbr>Class</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.ProductGroup.html" class="tsd-kind-icon">Product<wbr>Group</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.Scenario.html" class="tsd-kind-icon">Scenario</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="claWrapper.Variable.html" class="tsd-kind-icon">Variable</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/claWrapper.html#ItemType" class="tsd-kind-icon">Item<wbr>Type</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>