Documentation update.
This commit is contained in:
Spencer Ofwiti
@@ -8,7 +8,8 @@
|
||||
<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/style.css">
|
||||
<link rel="stylesheet" href="../styles/dark.css" media="(prefers-color-scheme: dark)">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
@@ -43,7 +44,9 @@
|
||||
|
||||
<ol class="breadcrumb">
|
||||
<li>Interfaces</li>
|
||||
<li>MutableKeyStore</li>
|
||||
<li
|
||||
>
|
||||
MutableKeyStore</li>
|
||||
</ol>
|
||||
|
||||
<ul class="nav nav-tabs" role="tablist">
|
||||
@@ -64,6 +67,7 @@
|
||||
<code>src/app/_pgp/pgp-key-store.ts</code>
|
||||
</p>
|
||||
|
||||
|
||||
<p class="comment">
|
||||
<h3>Description</h3>
|
||||
</p>
|
||||
@@ -92,79 +96,154 @@
|
||||
<td class="col-md-4">
|
||||
<ul class="index-list">
|
||||
<li>
|
||||
<a href="#clearKeysInKeyring">clearKeysInKeyring</a>
|
||||
<a href="#clearKeysInKeyring"
|
||||
>
|
||||
clearKeysInKeyring
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getEncryptKeys">getEncryptKeys</a>
|
||||
<a href="#getEncryptKeys"
|
||||
>
|
||||
getEncryptKeys
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getFingerprint">getFingerprint</a>
|
||||
<a href="#getFingerprint"
|
||||
>
|
||||
getFingerprint
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getKeyId">getKeyId</a>
|
||||
<a href="#getKeyId"
|
||||
>
|
||||
getKeyId
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getKeysForId">getKeysForId</a>
|
||||
<a href="#getKeysForId"
|
||||
>
|
||||
getKeysForId
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getPrivateKey">getPrivateKey</a>
|
||||
<a href="#getPrivateKey"
|
||||
>
|
||||
getPrivateKey
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getPrivateKeyForId">getPrivateKeyForId</a>
|
||||
<a href="#getPrivateKeyForId"
|
||||
>
|
||||
getPrivateKeyForId
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getPrivateKeyId">getPrivateKeyId</a>
|
||||
<a href="#getPrivateKeyId"
|
||||
>
|
||||
getPrivateKeyId
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getPrivateKeys">getPrivateKeys</a>
|
||||
<a href="#getPrivateKeys"
|
||||
>
|
||||
getPrivateKeys
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getPublicKeyForId">getPublicKeyForId</a>
|
||||
<a href="#getPublicKeyForId"
|
||||
>
|
||||
getPublicKeyForId
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getPublicKeyForSubkeyId">getPublicKeyForSubkeyId</a>
|
||||
<a href="#getPublicKeyForSubkeyId"
|
||||
>
|
||||
getPublicKeyForSubkeyId
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getPublicKeys">getPublicKeys</a>
|
||||
<a href="#getPublicKeys"
|
||||
>
|
||||
getPublicKeys
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getPublicKeysForAddress">getPublicKeysForAddress</a>
|
||||
<a href="#getPublicKeysForAddress"
|
||||
>
|
||||
getPublicKeysForAddress
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getTrustedActiveKeys">getTrustedActiveKeys</a>
|
||||
<a href="#getTrustedActiveKeys"
|
||||
>
|
||||
getTrustedActiveKeys
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getTrustedKeys">getTrustedKeys</a>
|
||||
<a href="#getTrustedKeys"
|
||||
>
|
||||
getTrustedKeys
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#importKeyPair">importKeyPair</a>
|
||||
<a href="#importKeyPair"
|
||||
>
|
||||
importKeyPair
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#importPrivateKey">importPrivateKey</a>
|
||||
<a href="#importPrivateKey"
|
||||
>
|
||||
importPrivateKey
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#importPublicKey">importPublicKey</a>
|
||||
<a href="#importPublicKey"
|
||||
>
|
||||
importPublicKey
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#isEncryptedPrivateKey">isEncryptedPrivateKey</a>
|
||||
<a href="#isEncryptedPrivateKey"
|
||||
>
|
||||
isEncryptedPrivateKey
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#isValidKey">isValidKey</a>
|
||||
<a href="#isValidKey"
|
||||
>
|
||||
isValidKey
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#loadKeyring">loadKeyring</a>
|
||||
<a href="#loadKeyring"
|
||||
>
|
||||
loadKeyring
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#removeKeysForId">removeKeysForId</a>
|
||||
<a href="#removeKeysForId"
|
||||
>
|
||||
removeKeysForId
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#removePublicKey">removePublicKey</a>
|
||||
<a href="#removePublicKey"
|
||||
>
|
||||
removePublicKey
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#removePublicKeyForId">removePublicKeyForId</a>
|
||||
<a href="#removePublicKeyForId"
|
||||
>
|
||||
removePublicKeyForId
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#sign">sign</a>
|
||||
<a href="#sign"
|
||||
>
|
||||
sign
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
@@ -184,9 +263,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="clearKeysInKeyring"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
clearKeysInKeyring
|
||||
</b>
|
||||
<span ><b>clearKeysInKeyring</b></span>
|
||||
<a href="#clearKeysInKeyring"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -208,7 +285,7 @@
|
||||
|
||||
<tr>
|
||||
<td class="col-md-4">
|
||||
<div class="io-description"><p>Remove all keys from the keyring. </p>
|
||||
<div class="io-description"><p>Remove all keys from the keyring.</p>
|
||||
</div>
|
||||
|
||||
<div class="io-description">
|
||||
@@ -225,9 +302,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getEncryptKeys"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getEncryptKeys
|
||||
</b>
|
||||
<span ><b>getEncryptKeys</b></span>
|
||||
<a href="#getEncryptKeys"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -249,7 +324,9 @@
|
||||
|
||||
<tr>
|
||||
<td class="col-md-4">
|
||||
<div class="io-description"><p>Get all the encryption keys.</p>
|
||||
<div class="io-description"><p>Get all the encryption keys.
|
||||
Current implementation doesn't include encryption keys.
|
||||
This is included to appease the implemented Keystore interface.</p>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
@@ -272,9 +349,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getFingerprint"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getFingerprint
|
||||
</b>
|
||||
<span ><b>getFingerprint</b></span>
|
||||
<a href="#getFingerprint"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -319,9 +394,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getKeyId"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getKeyId
|
||||
</b>
|
||||
<span ><b>getKeyId</b></span>
|
||||
<a href="#getKeyId"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -399,9 +472,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getKeysForId"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getKeysForId
|
||||
</b>
|
||||
<span ><b>getKeysForId</b></span>
|
||||
<a href="#getKeysForId"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -479,9 +550,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getPrivateKey"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getPrivateKey
|
||||
</b>
|
||||
<span ><b>getPrivateKey</b></span>
|
||||
<a href="#getPrivateKey"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -526,9 +595,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getPrivateKeyForId"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getPrivateKeyForId
|
||||
</b>
|
||||
<span ><b>getPrivateKeyForId</b></span>
|
||||
<a href="#getPrivateKeyForId"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -606,9 +673,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getPrivateKeyId"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getPrivateKeyId
|
||||
</b>
|
||||
<span ><b>getPrivateKeyId</b></span>
|
||||
<a href="#getPrivateKeyId"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -653,9 +718,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getPrivateKeys"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getPrivateKeys
|
||||
</b>
|
||||
<span ><b>getPrivateKeys</b></span>
|
||||
<a href="#getPrivateKeys"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -700,9 +763,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getPublicKeyForId"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getPublicKeyForId
|
||||
</b>
|
||||
<span ><b>getPublicKeyForId</b></span>
|
||||
<a href="#getPublicKeyForId"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -780,9 +841,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getPublicKeyForSubkeyId"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getPublicKeyForSubkeyId
|
||||
</b>
|
||||
<span ><b>getPublicKeyForSubkeyId</b></span>
|
||||
<a href="#getPublicKeyForSubkeyId"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -860,9 +919,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getPublicKeys"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getPublicKeys
|
||||
</b>
|
||||
<span ><b>getPublicKeys</b></span>
|
||||
<a href="#getPublicKeys"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -907,9 +964,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getPublicKeysForAddress"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getPublicKeysForAddress
|
||||
</b>
|
||||
<span ><b>getPublicKeysForAddress</b></span>
|
||||
<a href="#getPublicKeysForAddress"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -987,9 +1042,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getTrustedActiveKeys"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getTrustedActiveKeys
|
||||
</b>
|
||||
<span ><b>getTrustedActiveKeys</b></span>
|
||||
<a href="#getTrustedActiveKeys"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1034,9 +1087,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="getTrustedKeys"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
getTrustedKeys
|
||||
</b>
|
||||
<span ><b>getTrustedKeys</b></span>
|
||||
<a href="#getTrustedKeys"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1081,9 +1132,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="importKeyPair"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
importKeyPair
|
||||
</b>
|
||||
<span ><b>importKeyPair</b></span>
|
||||
<a href="#importKeyPair"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1178,9 +1227,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="importPrivateKey"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
importPrivateKey
|
||||
</b>
|
||||
<span ><b>importPrivateKey</b></span>
|
||||
<a href="#importPrivateKey"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1257,9 +1304,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="importPublicKey"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
importPublicKey
|
||||
</b>
|
||||
<span ><b>importPublicKey</b></span>
|
||||
<a href="#importPublicKey"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1336,9 +1381,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="isEncryptedPrivateKey"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
isEncryptedPrivateKey
|
||||
</b>
|
||||
<span ><b>isEncryptedPrivateKey</b></span>
|
||||
<a href="#isEncryptedPrivateKey"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1416,9 +1459,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="isValidKey"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
isValidKey
|
||||
</b>
|
||||
<span ><b>isValidKey</b></span>
|
||||
<a href="#isValidKey"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1496,9 +1537,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="loadKeyring"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
loadKeyring
|
||||
</b>
|
||||
<span ><b>loadKeyring</b></span>
|
||||
<a href="#loadKeyring"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1537,9 +1576,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="removeKeysForId"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
removeKeysForId
|
||||
</b>
|
||||
<span ><b>removeKeysForId</b></span>
|
||||
<a href="#removeKeysForId"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1617,9 +1654,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="removePublicKey"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
removePublicKey
|
||||
</b>
|
||||
<span ><b>removePublicKey</b></span>
|
||||
<a href="#removePublicKey"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1697,9 +1732,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="removePublicKeyForId"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
removePublicKeyForId
|
||||
</b>
|
||||
<span ><b>removePublicKeyForId</b></span>
|
||||
<a href="#removePublicKeyForId"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -1777,9 +1810,7 @@
|
||||
<td class="col-md-4">
|
||||
<a name="sign"></a>
|
||||
<span class="name">
|
||||
<b>
|
||||
sign
|
||||
</b>
|
||||
<span ><b>sign</b></span>
|
||||
<a href="#sign"><span class="icon ion-ios-link"></span></a>
|
||||
</span>
|
||||
</td>
|
||||
@@ -2324,9 +2355,9 @@ export { MutableKeyStore, MutablePgpKeyStore };
|
||||
|
||||
<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 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>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user