UNPKG

codingame-api-node-ts

Version:

A CodinGame API node, that permits you to access all of the endpoints of this website. Wrote in TypeScript, so you can previsualize how the response will look like by checking the code.

437 lines 23.2 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ILoginCodinGamer | codingame-api-node-ts</title> <meta name="description" content="Documentation for codingame-api-node-ts"> <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">codingame-api-node-ts</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">codingame-api-node-ts</a> </li> <li> <a href="ilogincodingamer.html">ILoginCodinGamer</a> </li> </ul> <h1>Interface ILoginCodinGamer</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">ILoginCodinGamer</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>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#actiontypes" class="tsd-kind-icon">action<wbr>Types</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#activatedfeatures" class="tsd-kind-icon">activated<wbr>Features</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#admin" class="tsd-kind-icon">admin</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#chattoken" class="tsd-kind-icon">chat<wbr>Token</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#codingamer" class="tsd-kind-icon">codin<wbr>Gamer</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#cookies" class="tsd-kind-icon">cookies</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#countrycode" class="tsd-kind-icon">country<wbr>Code</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#disqusssopayload" class="tsd-kind-icon">disqus<wbr>Sso<wbr>Payload</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#enablednotifications" class="tsd-kind-icon">enabled<wbr>Notifications</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#gavefeedbackoncurrentcompany" class="tsd-kind-icon">gave<wbr>Feedback<wbr>OnCurrent<wbr>Company</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#impersonated" class="tsd-kind-icon">impersonated</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#languageid" class="tsd-kind-icon">language<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#newfeatures" class="tsd-kind-icon">new<wbr>Features</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#notificationconfig" class="tsd-kind-icon">notification<wbr>Config</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#user" class="tsd-kind-icon">user</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#useremail" class="tsd-kind-icon">user<wbr>Email</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#userid" class="tsd-kind-icon">user<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#visitor" class="tsd-kind-icon">visitor</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ilogincodingamer.html#xpthresholds" class="tsd-kind-icon">xp<wbr>Thresholds</a></li> </ul> </section> </div> </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-interface"> <a name="actiontypes" class="tsd-anchor"></a> <h3>action<wbr>Types</h3> <div class="tsd-signature tsd-kind-icon">action<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">actionTypes</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L35">lib/api/auth.ts:35</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="activatedfeatures" class="tsd-anchor"></a> <h3>activated<wbr>Features</h3> <div class="tsd-signature tsd-kind-icon">activated<wbr>Features<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L34">lib/api/auth.ts:34</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="admin" class="tsd-anchor"></a> <h3>admin</h3> <div class="tsd-signature tsd-kind-icon">admin<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/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L42">lib/api/auth.ts:42</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="chattoken" class="tsd-anchor"></a> <h3>chat<wbr>Token</h3> <div class="tsd-signature tsd-kind-icon">chat<wbr>Token<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/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L36">lib/api/auth.ts:36</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="codingamer" class="tsd-anchor"></a> <h3>codin<wbr>Gamer</h3> <div class="tsd-signature tsd-kind-icon">codin<wbr>Gamer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">codinGamer</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L29">lib/api/auth.ts:29</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="cookies" class="tsd-anchor"></a> <h3>cookies</h3> <div class="tsd-signature tsd-kind-icon">cookies<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/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L47">lib/api/auth.ts:47</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="countrycode" class="tsd-anchor"></a> <h3>country<wbr>Code</h3> <div class="tsd-signature tsd-kind-icon">country<wbr>Code<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/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L30">lib/api/auth.ts:30</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="disqusssopayload" class="tsd-anchor"></a> <h3>disqus<wbr>Sso<wbr>Payload</h3> <div class="tsd-signature tsd-kind-icon">disqus<wbr>Sso<wbr>Payload<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/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L37">lib/api/auth.ts:37</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="enablednotifications" class="tsd-anchor"></a> <h3>enabled<wbr>Notifications</h3> <div class="tsd-signature tsd-kind-icon">enabled<wbr>Notifications<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L32">lib/api/auth.ts:32</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="gavefeedbackoncurrentcompany" class="tsd-anchor"></a> <h3>gave<wbr>Feedback<wbr>OnCurrent<wbr>Company</h3> <div class="tsd-signature tsd-kind-icon">gave<wbr>Feedback<wbr>OnCurrent<wbr>Company<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/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L38">lib/api/auth.ts:38</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="impersonated" class="tsd-anchor"></a> <h3>impersonated</h3> <div class="tsd-signature tsd-kind-icon">impersonated<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/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L46">lib/api/auth.ts:46</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="languageid" class="tsd-anchor"></a> <h3>language<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">language<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L43">lib/api/auth.ts:43</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="newfeatures" class="tsd-anchor"></a> <h3>new<wbr>Features</h3> <div class="tsd-signature tsd-kind-icon">new<wbr>Features<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L31">lib/api/auth.ts:31</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="notificationconfig" class="tsd-anchor"></a> <h3>notification<wbr>Config</h3> <div class="tsd-signature tsd-kind-icon">notification<wbr>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">notificationConfig</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L33">lib/api/auth.ts:33</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="user" class="tsd-anchor"></a> <h3>user</h3> <div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">codinGameUser</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L40">lib/api/auth.ts:40</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="useremail" class="tsd-anchor"></a> <h3>user<wbr>Email</h3> <div class="tsd-signature tsd-kind-icon">user<wbr>Email<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/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L45">lib/api/auth.ts:45</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="userid" class="tsd-anchor"></a> <h3>user<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">user<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L44">lib/api/auth.ts:44</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="visitor" class="tsd-anchor"></a> <h3>visitor</h3> <div class="tsd-signature tsd-kind-icon">visitor<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/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L41">lib/api/auth.ts:41</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="xpthresholds" class="tsd-anchor"></a> <h3>xp<wbr>Thresholds</h3> <div class="tsd-signature tsd-kind-icon">xp<wbr>Thresholds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">xpThresholds</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L39">lib/api/auth.ts:39</a></li> </ul> </aside> </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">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-interface"> <a href="iclashleaderboard.html" class="tsd-kind-icon">IClash<wbr>Leaderboard</a> </li> <li class=" tsd-kind-interface"> <a href="igloballeaderboard.html" class="tsd-kind-icon">IGlobal<wbr>Leaderboard</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface"> <a href="ilogincodingamer.html" class="tsd-kind-icon">ILogin<wbr>Codin<wbr>Gamer</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#actiontypes" class="tsd-kind-icon">action<wbr>Types</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#activatedfeatures" class="tsd-kind-icon">activated<wbr>Features</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#admin" class="tsd-kind-icon">admin</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#chattoken" class="tsd-kind-icon">chat<wbr>Token</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#codingamer" class="tsd-kind-icon">codin<wbr>Gamer</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#cookies" class="tsd-kind-icon">cookies</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#countrycode" class="tsd-kind-icon">country<wbr>Code</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#disqusssopayload" class="tsd-kind-icon">disqus<wbr>Sso<wbr>Payload</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#enablednotifications" class="tsd-kind-icon">enabled<wbr>Notifications</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#gavefeedbackoncurrentcompany" class="tsd-kind-icon">gave<wbr>Feedback<wbr>OnCurrent<wbr>Company</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#impersonated" class="tsd-kind-icon">impersonated</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#languageid" class="tsd-kind-icon">language<wbr>Id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#newfeatures" class="tsd-kind-icon">new<wbr>Features</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#notificationconfig" class="tsd-kind-icon">notification<wbr>Config</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#user" class="tsd-kind-icon">user</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#useremail" class="tsd-kind-icon">user<wbr>Email</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#userid" class="tsd-kind-icon">user<wbr>Id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#visitor" class="tsd-kind-icon">visitor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ilogincodingamer.html#xpthresholds" class="tsd-kind-icon">xp<wbr>Thresholds</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface"> <a href="ipuzzleminimalprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Minimal<wbr>Progress</a> </li> <li class=" tsd-kind-interface"> <a href="ipuzzleprettyprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Pretty<wbr>Progress</a> </li> <li class=" tsd-kind-interface"> <a href="ipuzzleprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Progress</a> </li> <li class=" tsd-kind-variable"> <a href="../modules.html#urls" class="tsd-kind-icon">urls</a> </li> <li class=" tsd-kind-function"> <a href="../modules.html#findallminimalprogress" class="tsd-kind-icon">find<wbr>All<wbr>Minimal<wbr>Progress</a> </li> <li class=" tsd-kind-function"> <a href="../modules.html#findprogressbyids" class="tsd-kind-icon">find<wbr>Progress<wbr>ByIds</a> </li> <li class=" tsd-kind-function"> <a href="../modules.html#findprogressbyprettyid" class="tsd-kind-icon">find<wbr>Progress<wbr>ByPretty<wbr>Id</a> </li> <li class=" tsd-kind-function"> <a href="../modules.html#getclashleaderboard" class="tsd-kind-icon">get<wbr>Clash<wbr>Leaderboard</a> </li> <li class=" tsd-kind-function"> <a href="../modules.html#getcookies" class="tsd-kind-icon">get<wbr>Cookies</a> </li> <li class=" tsd-kind-function"> <a href="../modules.html#getgloballeaderboard" class="tsd-kind-icon">get<wbr>Global<wbr>Leaderboard</a> </li> <li class=" tsd-kind-function"> <a href="../modules.html#logincodingamer" class="tsd-kind-icon">login<wbr>Codin<wbr>Gamer</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>