785 lines
28 KiB
HTML
785 lines
28 KiB
HTML
<!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">
|
|
<link rel="stylesheet" href="../styles/dark.css" media="(prefers-color-scheme: dark)">
|
|
</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>
|
|
|
|
|
|
<p class="comment">
|
|
<h3>Description</h3>
|
|
</p>
|
|
<p class="comment">
|
|
<p>Account data interface</p>
|
|
|
|
</p>
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Age of user</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Token balance on account</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Business category of user.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Account registration day</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>User's gender</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Account identifiers</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>User's location</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Products or services provided by user.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Type of account</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<div class="io-description"><p>Personal identifying information of user</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</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 {
|
|
/** Age of user */
|
|
age?: string;
|
|
/** Token balance on account */
|
|
balance?: number;
|
|
/** Business category of user. */
|
|
category?: string;
|
|
/** Account registration day */
|
|
date_registered: number;
|
|
/** User's gender */
|
|
gender: string;
|
|
/** Account identifiers */
|
|
identities: {
|
|
evm: {
|
|
'bloxberg:8996': string[];
|
|
'oldchain:1': string[];
|
|
};
|
|
latitude: number;
|
|
longitude: number;
|
|
};
|
|
/** User's location */
|
|
location: {
|
|
area?: string;
|
|
area_name: string;
|
|
area_type?: string;
|
|
};
|
|
/** Products or services provided by user. */
|
|
products: string[];
|
|
/** Type of account */
|
|
type?: string;
|
|
/** Personal identifying information of user */
|
|
vcard: {
|
|
email: [
|
|
{
|
|
value: string;
|
|
}
|
|
];
|
|
fn: [
|
|
{
|
|
value: string;
|
|
}
|
|
];
|
|
n: [
|
|
{
|
|
value: string[];
|
|
}
|
|
];
|
|
tel: [
|
|
{
|
|
meta: {
|
|
TYP: string[];
|
|
};
|
|
value: string;
|
|
}
|
|
];
|
|
version: [
|
|
{
|
|
value: string;
|
|
}
|
|
];
|
|
};
|
|
}
|
|
|
|
/** Meta signature interface */
|
|
interface Signature {
|
|
/** Algorithm used */
|
|
algo: string;
|
|
/** Data that was signed. */
|
|
data: string;
|
|
/** Message digest */
|
|
digest: string;
|
|
/** Encryption engine used. */
|
|
engine: string;
|
|
}
|
|
|
|
/** Meta object interface */
|
|
interface Meta {
|
|
/** Account details */
|
|
data: AccountDetails;
|
|
/** Meta store id */
|
|
id: string;
|
|
/** Signature used during write. */
|
|
signature: Signature;
|
|
}
|
|
|
|
/** Meta response interface */
|
|
interface MetaResponse {
|
|
/** Meta store id */
|
|
id: string;
|
|
/** Meta object */
|
|
m: Meta;
|
|
}
|
|
|
|
/** Default account data object */
|
|
const defaultAccount: AccountDetails = {
|
|
date_registered: Date.now(),
|
|
gender: 'other',
|
|
identities: {
|
|
evm: {
|
|
'bloxberg:8996': [''],
|
|
'oldchain:1': [''],
|
|
},
|
|
latitude: 0,
|
|
longitude: 0,
|
|
},
|
|
location: {
|
|
area_name: 'Kilifi',
|
|
},
|
|
products: [],
|
|
vcard: {
|
|
email: [
|
|
{
|
|
value: '',
|
|
},
|
|
],
|
|
fn: [
|
|
{
|
|
value: 'Sarafu Contract',
|
|
},
|
|
],
|
|
n: [
|
|
{
|
|
value: ['Sarafu', 'Contract'],
|
|
},
|
|
],
|
|
tel: [
|
|
{
|
|
meta: {
|
|
TYP: [],
|
|
},
|
|
value: '+254700000000',
|
|
},
|
|
],
|
|
version: [
|
|
{
|
|
value: '3.0',
|
|
},
|
|
],
|
|
},
|
|
};
|
|
|
|
/** @exports */
|
|
export { AccountDetails, Meta, MetaResponse, Signature, defaultAccount };
|
|
</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>
|
|
|
|
<script type="module" src="../js/menu-wc.js" defer></script>
|
|
<script nomodule src="../js/menu-wc_es5.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>
|