grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
0343142a38
cic-staff-client/docs/compodoc/interfaces/AccountDetails.html

711 lines
25 KiB
HTML
Raw Normal View History

Add docs.
2021-05-10 20:56:20 +02:00
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>CICADA</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">CICADA</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" 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> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content interface">
<div class="content-data">
<ol class="breadcrumb">
<li>Interfaces</li>
<li>AccountDetails</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/_models/account.ts</code>
</p>
Add documentation to models.
2021-05-12 08:40:21 +02:00
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Account data interface </p>
</p>
Add docs.
2021-05-10 20:56:20 +02:00
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Optional</span>
<a href="#age">age</a>
</li>
<li>
<span class="modifier">Optional</span>
<a href="#balance">balance</a>
</li>
<li>
<span class="modifier">Optional</span>
<a href="#category">category</a>
</li>
<li>
<a href="#date_registered">date_registered</a>
</li>
<li>
<a href="#gender">gender</a>
</li>
<li>
<a href="#identities">identities</a>
</li>
<li>
<a href="#location">location</a>
</li>
<li>
<a href="#products">products</a>
</li>
<li>
<span class="modifier">Optional</span>
<a href="#type">type</a>
</li>
<li>
<a href="#vcard">vcard</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="inputs">Properties</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="age"></a>
<span class="name"><b>age</b><a href="#age"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>age: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Optional</i>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Age of user </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="balance"></a>
<span class="name"><b>balance</b><a href="#balance"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>balance: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Optional</i>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Token balance on account </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="category"></a>
<span class="name"><b>category</b><a href="#category"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>category: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Optional</i>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Business category of user. </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="date_registered"></a>
<span class="name"><b>date_registered</b><a href="#date_registered"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>date_registered: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Account registration day </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="gender"></a>
<span class="name"><b>gender</b><a href="#gender"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>gender: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>User&#39;s gender </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="identities"></a>
<span class="name"><b>identities</b><a href="#identities"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>identities: <code>literal type</code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>literal type</code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Account identifiers </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="location"></a>
<span class="name"><b>location</b><a href="#location"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>location: <code>literal type</code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>literal type</code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>User&#39;s location </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="products"></a>
<span class="name"><b>products</b><a href="#products"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>products: <code>string[]</code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string[]</code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Products or services provided by user. </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="type"></a>
<span class="name"><b>type</b><a href="#type"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>type: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Optional</i>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Type of account </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="vcard"></a>
<span class="name"><b>vcard</b><a href="#vcard"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>vcard: <code>literal type</code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>literal type</code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Personal identifying information of user </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface AccountDetails {
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Age of user */
Add docs.
2021-05-10 20:56:20 +02:00
age?: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Token balance on account */
Add docs.
2021-05-10 20:56:20 +02:00
balance?: number;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** Business category of user. */
category?: string;
/** Account registration day */
date_registered: number;
/** User&#x27;s gender */
gender: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Account identifiers */
Add docs.
2021-05-10 20:56:20 +02:00
identities: {
evm: {
&#x27;bloxberg:8996&#x27;: string[];
&#x27;oldchain:1&#x27;: string[];
};
latitude: number;
longitude: number;
};
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** User&#x27;s location */
Add docs.
2021-05-10 20:56:20 +02:00
location: {
area?: string;
area_name: string;
area_type?: string;
};
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Products or services provided by user. */
Add docs.
2021-05-10 20:56:20 +02:00
products: string[];
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** Type of account */
type?: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Personal identifying information of user */
Add docs.
2021-05-10 20:56:20 +02:00
vcard: {
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
email: [
{
value: string;
}
];
fn: [
{
value: string;
}
];
n: [
{
value: string[];
}
];
tel: [
{
meta: {
TYP: string[];
};
value: string;
}
];
version: [
{
value: string;
}
];
Add docs.
2021-05-10 20:56:20 +02:00
};
}
Add documentation to models.
2021-05-12 08:40:21 +02:00
/** Meta signature interface */
Add docs.
2021-05-10 20:56:20 +02:00
interface Signature {
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Algorithm used */
Add docs.
2021-05-10 20:56:20 +02:00
algo: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Data that was signed. */
Add docs.
2021-05-10 20:56:20 +02:00
data: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Message digest */
Add docs.
2021-05-10 20:56:20 +02:00
digest: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Encryption engine used. */
Add docs.
2021-05-10 20:56:20 +02:00
engine: string;
}
Add documentation to models.
2021-05-12 08:40:21 +02:00
/** Meta object interface */
Add docs.
2021-05-10 20:56:20 +02:00
interface Meta {
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Account details */
Add docs.
2021-05-10 20:56:20 +02:00
data: AccountDetails;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Meta store id */
Add docs.
2021-05-10 20:56:20 +02:00
id: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Signature used during write. */
Add docs.
2021-05-10 20:56:20 +02:00
signature: Signature;
}
Add documentation to models.
2021-05-12 08:40:21 +02:00
/** Meta response interface */
Add docs.
2021-05-10 20:56:20 +02:00
interface MetaResponse {
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Meta store id */
Add docs.
2021-05-10 20:56:20 +02:00
id: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Meta object */
Add docs.
2021-05-10 20:56:20 +02:00
m: Meta;
}
Add documentation to models.
2021-05-12 08:40:21 +02:00
/** Default account data object */
Add docs.
2021-05-10 20:56:20 +02:00
const defaultAccount: AccountDetails &#x3D; {
date_registered: Date.now(),
gender: &#x27;other&#x27;,
identities: {
evm: {
&#x27;bloxberg:8996&#x27;: [&#x27;&#x27;],
&#x27;oldchain:1&#x27;: [&#x27;&#x27;],
},
latitude: 0,
longitude: 0,
},
location: {
area_name: &#x27;Kilifi&#x27;,
},
products: [],
vcard: {
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
email: [
{
value: &#x27;&#x27;,
},
],
fn: [
{
value: &#x27;Sarafu Contract&#x27;,
},
],
n: [
{
value: [&#x27;Sarafu&#x27;, &#x27;Contract&#x27;],
Add docs.
2021-05-10 20:56:20 +02:00
},
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
],
tel: [
{
meta: {
TYP: [],
},
Refactor mapping of curated options from meta.
2021-06-23 09:18:28 +02:00
value: &#x27;+254700000000&#x27;,
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
},
],
version: [
{
value: &#x27;3.0&#x27;,
},
],
Add docs.
2021-05-10 20:56:20 +02:00
},
};
Add documentation to models.
2021-05-12 08:40:21 +02:00
/** @exports */
export { AccountDetails, Meta, MetaResponse, Signature, defaultAccount };
Add docs.
2021-05-10 20:56:20 +02:00
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-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>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
var COMPODOC_CURRENT_PAGE_URL = 'AccountDetails.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="../js/menu-wc.js" defer></script>
<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/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.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/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink