TelegramAktienBot/frontend/documentation/miscellaneous.html
2022-05-10 13:03:10 +02:00

699 lines
30 KiB
HTML

<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>aktienbot documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="./images/favicon.ico">
<link rel="stylesheet" href="./styles/style.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="./" class="navbar-brand">aktienbot documentation</a>
<button type="button" class="btn btn-default btn-menu fa fa-bars" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search">
</div>
<nav>
<ul class="list">
<li class="title">
<a href="./">aktienbot documentation</a>
</li>
<li class="divider"></li>
<li class="chapter">
<a data-type="chapter-link" href="./"><span class="fa fa-home"></span>Getting started</a>
<ul class="links">
<li class="link">
<a href="./" ><span class="fa fa-file-text-o"></span>README</a>
</li>
<li class="link">
<a
href="./overview.html"
href="./overview.html"
>
<span class="fa fa-th"></span>Overview
</a>
</li>
</ul>
</li>
<li class="chapter">
<a data-type="chapter-link" href="./modules.html" >
<span class="fa fa-archive"></span>
<span>Modules</span>
<span class="menu-toggler fa fa-angle-up" data-toggle="collapse"
data-target="#xs-modules-links"
></span>
</a>
<ul class="links collapse in"
id="xs-modules-links"
>
<li class="link">
<a href="modules/AppModule.html" >AppModule</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple">
<span class="fa fa-cogs"></span>
<span>Components</span>
<span class="menu-toggler fa fa-angle-up" data-toggle="collapse"
data-target="#xs-components-links"
></span>
</div>
<ul class="links collapse in"
id="xs-components-links"
>
<li class="link">
<a href="components/AppComponent.html" >AppComponent</a>
</li>
<li class="link">
<a href="components/BotSettingsComponent.html" >BotSettingsComponent</a>
</li>
<li class="link">
<a href="components/ConfirmationDialogComponent.html" >ConfirmationDialogComponent</a>
</li>
<li class="link">
<a href="components/DashboardComponent.html" >DashboardComponent</a>
</li>
<li class="link">
<a href="components/HeaderComponent.html" >HeaderComponent</a>
</li>
<li class="link">
<a href="components/HelpDialogComponent.html" >HelpDialogComponent</a>
</li>
<li class="link">
<a href="components/LoginComponent.html" >LoginComponent</a>
</li>
<li class="link">
<a href="components/ProfileComponent.html" >ProfileComponent</a>
</li>
<li class="link">
<a href="components/RegisterComponent.html" >RegisterComponent</a>
</li>
<li class="link">
<a href="components/UserDialogComponent.html" >UserDialogComponent</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple">
<span class="fa fa-long-arrow-down"></span>
<span>Injectables</span>
<span class="menu-toggler fa fa-angle-up" data-toggle="collapse"
data-target="#xs-injectables-links"
></span>
</div>
<ul class="links collapse in"
id="xs-injectables-links"
>
<li class="link">
<a href="injectables/AuthInterceptor.html" >AuthInterceptor</a>
</li>
<li class="link">
<a href="injectables/AuthService.html" >AuthService</a>
</li>
<li class="link">
<a href="injectables/BotService.html" >BotService</a>
</li>
<li class="link">
<a href="injectables/DataService.html" >DataService</a>
</li>
<li class="link">
<a href="injectables/HelperService.html" >HelperService</a>
</li>
<li class="link">
<a href="injectables/ProfileService.html" >ProfileService</a>
</li>
<li class="link">
<a href="injectables/TokenStorageService.html" >TokenStorageService</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple">
<span class="fa fa-info"></span>
<span>Interfaces</span>
<span class="menu-toggler fa fa-angle-up" data-toggle="collapse"
data-target="#xs-interfaces-links"
></span>
</div>
<ul class="links collapse in"
id="xs-interfaces-links"
>
<li class="link">
<a href="interfaces/Keyword.html" >Keyword</a>
</li>
<li class="link">
<a href="interfaces/Share.html" >Share</a>
</li>
<li class="link">
<a href="interfaces/Stock.html" >Stock</a>
</li>
<li class="link">
<a href="interfaces/TransactionData.html" >TransactionData</a>
</li>
</ul>
</li>
<li class="chapter">
<a data-type="chapter-link" href="./miscellaneous.html" class="active" ><span class="fa fa-cubes"></span>Miscellaneous</a>
</li>
<li class="chapter">
<a data-type="chapter-link" href="./coverage.html" ><span class="fa fa-tasks"></span>Documentation coverage</a>
</li>
<li class="divider"></li>
<li class="copyright">
Documentation generated using <a href="https://compodoc.github.io/compodoc/" target="_blank">
<img src=".//images/compodoc-vectorise.svg" class="img-responsive">
</a>
</li>
</ul>
</nav>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<nav>
<ul class="list">
<li class="title">
<a href="./">aktienbot documentation</a>
</li>
<li class="divider"></li>
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search">
</div>
<li class="chapter">
<a data-type="chapter-link" href="./"><span class="fa fa-home"></span>Getting started</a>
<ul class="links">
<li class="link">
<a href="./" ><span class="fa fa-file-text-o"></span>README</a>
</li>
<li class="link">
<a
href="./overview.html"
href="./overview.html"
>
<span class="fa fa-th"></span>Overview
</a>
</li>
</ul>
</li>
<li class="chapter">
<a data-type="chapter-link" href="./modules.html" >
<span class="fa fa-archive"></span>
<span>Modules</span>
<span class="menu-toggler fa fa-angle-up" data-toggle="collapse"
data-target="#modules-links"
></span>
</a>
<ul class="links collapse in"
id="modules-links"
>
<li class="link">
<a href="modules/AppModule.html" >AppModule</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple">
<span class="fa fa-cogs"></span>
<span>Components</span>
<span class="menu-toggler fa fa-angle-up" data-toggle="collapse"
data-target="#components-links"
></span>
</div>
<ul class="links collapse in"
id="components-links"
>
<li class="link">
<a href="components/AppComponent.html" >AppComponent</a>
</li>
<li class="link">
<a href="components/BotSettingsComponent.html" >BotSettingsComponent</a>
</li>
<li class="link">
<a href="components/ConfirmationDialogComponent.html" >ConfirmationDialogComponent</a>
</li>
<li class="link">
<a href="components/DashboardComponent.html" >DashboardComponent</a>
</li>
<li class="link">
<a href="components/HeaderComponent.html" >HeaderComponent</a>
</li>
<li class="link">
<a href="components/HelpDialogComponent.html" >HelpDialogComponent</a>
</li>
<li class="link">
<a href="components/LoginComponent.html" >LoginComponent</a>
</li>
<li class="link">
<a href="components/ProfileComponent.html" >ProfileComponent</a>
</li>
<li class="link">
<a href="components/RegisterComponent.html" >RegisterComponent</a>
</li>
<li class="link">
<a href="components/UserDialogComponent.html" >UserDialogComponent</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple">
<span class="fa fa-long-arrow-down"></span>
<span>Injectables</span>
<span class="menu-toggler fa fa-angle-up" data-toggle="collapse"
data-target="#injectables-links"
></span>
</div>
<ul class="links collapse in"
id="injectables-links"
>
<li class="link">
<a href="injectables/AuthInterceptor.html" >AuthInterceptor</a>
</li>
<li class="link">
<a href="injectables/AuthService.html" >AuthService</a>
</li>
<li class="link">
<a href="injectables/BotService.html" >BotService</a>
</li>
<li class="link">
<a href="injectables/DataService.html" >DataService</a>
</li>
<li class="link">
<a href="injectables/HelperService.html" >HelperService</a>
</li>
<li class="link">
<a href="injectables/ProfileService.html" >ProfileService</a>
</li>
<li class="link">
<a href="injectables/TokenStorageService.html" >TokenStorageService</a>
</li>
</ul>
</li>
<li class="chapter">
<div class="simple">
<span class="fa fa-info"></span>
<span>Interfaces</span>
<span class="menu-toggler fa fa-angle-up" data-toggle="collapse"
data-target="#interfaces-links"
></span>
</div>
<ul class="links collapse in"
id="interfaces-links"
>
<li class="link">
<a href="interfaces/Keyword.html" >Keyword</a>
</li>
<li class="link">
<a href="interfaces/Share.html" >Share</a>
</li>
<li class="link">
<a href="interfaces/Stock.html" >Stock</a>
</li>
<li class="link">
<a href="interfaces/TransactionData.html" >TransactionData</a>
</li>
</ul>
</li>
<li class="chapter">
<a data-type="chapter-link" href="./miscellaneous.html" class="active" ><span class="fa fa-cubes"></span>Miscellaneous</a>
</li>
<li class="chapter">
<a data-type="chapter-link" href="./coverage.html" ><span class="fa fa-tasks"></span>Documentation coverage</a>
</li>
<li class="divider"></li>
<li class="copyright">
Documentation generated using <a href="https://compodoc.github.io/compodoc/" target="_blank">
<img src=".//images/compodoc-vectorise.svg" class="img-responsive">
</a>
</li>
</ul>
</nav>
</div>
<div class="content miscellaneous">
<div class="content-data">
<ol class="breadcrumb">
<li>Miscellaneous</li>
</ol>
<section>
<h3 id="inputs">Variables</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> TOKEN_HEADER_KEY</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>TOKEN_HEADER_KEY: <code></code>
</bcode>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value: </i><code>Authorization</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> authInterceptorProviders</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>authInterceptorProviders: <code></code>
</bcode>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> AUTH_API</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>AUTH_API: <code></code>
</bcode>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value: </i><code>https://gruppe1.testsites.info/api/user</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> httpOptions</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>httpOptions: <code></code>
</bcode>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> API_URL</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>API_URL: <code></code>
</bcode>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value: </i><code>https://gruppe1.testsites.info/api/</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> API_URL</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>API_URL: <code></code>
</bcode>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value: </i><code>https://gruppe1.testsites.info/api/</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> API_URL</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>API_URL: <code></code>
</bcode>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value: </i><code>https://gruppe1.testsites.info/api/</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> TOKEN_KEY</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>TOKEN_KEY: <code></code>
</bcode>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value: </i><code>auth-token</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> USER_KEY</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>USER_KEY: <code></code>
</bcode>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value: </i><code>auth-user</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> TRANSACTION_DATA</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>TRANSACTION_DATA: <code>TransactionData[]</code>
</bcode>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> STOCK_DATA</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>STOCK_DATA: <code>Stock[]</code>
</bcode>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> environment</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>environment: <code></code>
</bcode>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> environment</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>environment: <code></code>
</bcode>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> require</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>require: <code>{ context(path: string, deep?: boolean, filter?: RegExp): { &lt;T&gt;(id: string): T; keys(): string[];...</code>
</bcode>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<b> context</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>context: <code></code>
</bcode>
</td>
</tr>
</tbody>
</table>
</section>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
<script src="./js/libs/bootstrap-native.js"></script>
<script src="./js/libs/es6-shim.min.js"></script>
<script src="./js/libs/EventDispatcher.js"></script>
<script src="./js/libs/promise.min.js"></script>
<script src="./js/libs/zepto.min.js"></script>
<script src="./js/compodoc.js"></script>
<script src="./js/search/search.js"></script>
<script src="./js/search/lunr.min.js"></script>
<script src="./js/search/search-lunr.js"></script>
<script src="./js/menu.js"></script>
<script src="./js/libs/highlight.pack.js"></script>
<script src="./js/libs/highlightjs-line-numbers.min.js"></script>
<script src="./js/search/search_index.js"></script>
<script>
document.addEventListener('DOMContentLoaded', function() {
hljs.initHighlightingOnLoad();
hljs.initLineNumbersOnLoad();
});
</script>
</body>
</html>