Deployed c157de7 with MkDocs version: 1.6.1

reference/identity/index.html

@@ -27,7 +27,7 @@
 <a id=__codelineno-6-3 name=__codelineno-6-3 href=#__codelineno-6-3></a><span class=w>    </span><span class=k>async</span><span class=w> </span><span class=nx>publiclyRevealAttributes</span><span class=p>(</span><span class=nx>certificate</span><span class=o>:</span><span class=w> </span><span class=kt>WalletCertificate</span><span class=p>,</span><span class=w> </span><span class=nx>fieldsToReveal</span><span class=o>:</span><span class=w> </span><span class=kt>CertificateFieldNameUnder50Bytes</span><span class=p>[])</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=nx>BroadcastResponse</span><span class=w> </span><span class=o>|</span><span class=w> </span><span class=nx>BroadcastFailure</span><span class=o>&gt;</span><span class=w> </span>
 <a id=__codelineno-6-4 name=__codelineno-6-4 href=#__codelineno-6-4></a><span class=w>    </span><span class=k>async</span><span class=w> </span><span class=nx>resolveByIdentityKey</span><span class=p>(</span><span class=nx>args</span><span class=o>:</span><span class=w> </span><span class=kt>DiscoverByIdentityKeyArgs</span><span class=p>,</span><span class=w> </span><span class=nx>overrideWithContacts</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=kc>true</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=nx>DisplayableIdentity</span><span class=p>[]</span><span class=o>&gt;</span><span class=w> </span>
 <a id=__codelineno-6-5 name=__codelineno-6-5 href=#__codelineno-6-5></a><span class=w>    </span><span class=k>async</span><span class=w> </span><span class=nx>resolveByAttributes</span><span class=p>(</span><span class=nx>args</span><span class=o>:</span><span class=w> </span><span class=kt>DiscoverByAttributesArgs</span><span class=p>,</span><span class=w> </span><span class=nx>overrideWithContacts</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=kc>true</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=nx>DisplayableIdentity</span><span class=p>[]</span><span class=o>&gt;</span><span class=w> </span>
-<a id=__codelineno-6-6 name=__codelineno-6-6 href=#__codelineno-6-6></a><span class=w>    </span><span class=k>async</span><span class=w> </span><span class=nx>revokeCertificateRevelation</span><span class=p>(</span><span class=nx>serialNumber</span><span class=o>:</span><span class=w> </span><span class=kt>Base64String</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=nx>BroadcastResponse</span><span class=w> </span><span class=o>|</span><span class=w> </span><span class=nx>BroadcastFailure</span><span class=o>&gt;</span><span class=w> </span>
+<a id=__codelineno-6-6 name=__codelineno-6-6 href=#__codelineno-6-6></a><span class=w>    </span><span class=k>async</span><span class=w> </span><span class=nx>revokeCertificateRevelation</span><span class=p>(</span><span class=nx>serialNumber</span><span class=o>:</span><span class=w> </span><span class=kt>Base64String</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=ow>void</span><span class=o>&gt;</span><span class=w> </span>
 <a id=__codelineno-6-7 name=__codelineno-6-7 href=#__codelineno-6-7></a><span class=w>    </span><span class=k>public</span><span class=w> </span><span class=k>async</span><span class=w> </span><span class=nx>getContacts</span><span class=p>(</span><span class=nx>identityKey?</span><span class=o>:</span><span class=w> </span><span class=kt>PubKeyHex</span><span class=p>,</span><span class=w> </span><span class=nx>forceRefresh</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w> </span><span class=nx>limit</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>1000</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=nx>Contact</span><span class=p>[]</span><span class=o>&gt;</span><span class=w> </span>
 <a id=__codelineno-6-8 name=__codelineno-6-8 href=#__codelineno-6-8></a><span class=w>    </span><span class=k>public</span><span class=w> </span><span class=k>async</span><span class=w> </span><span class=nx>saveContact</span><span class=p>(</span><span class=nx>contact</span><span class=o>:</span><span class=w> </span><span class=kt>DisplayableIdentity</span><span class=p>,</span><span class=w> </span><span class=nx>metadata?</span><span class=o>:</span><span class=w> </span><span class=kt>Record</span><span class=o>&lt;</span><span class=kt>string</span><span class=p>,</span><span class=w> </span><span class=nx>any</span><span class=o>&gt;</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=ow>void</span><span class=o>&gt;</span><span class=w> </span>
 <a id=__codelineno-6-9 name=__codelineno-6-9 href=#__codelineno-6-9></a><span class=w>    </span><span class=k>public</span><span class=w> </span><span class=k>async</span><span class=w> </span><span class=nx>removeContact</span><span class=p>(</span><span class=nx>identityKey</span><span class=o>:</span><span class=w> </span><span class=kt>PubKeyHex</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=ow>void</span><span class=o>&gt;</span><span class=w> </span>
@@ -39,8 +39,8 @@
 </code></pre></div> See also: <a href=../transaction/#interface-broadcastfailure>BroadcastFailure</a>, <a href=../transaction/#interface-broadcastresponse>BroadcastResponse</a>, <a href=../wallet/#type-certificatefieldnameunder50bytes>CertificateFieldNameUnder50Bytes</a>, <a href=../wallet/#interface-walletcertificate>WalletCertificate</a></p> <p>Returns</p> <p>A promise that resolves with the broadcast result from the overlay network.</p> <p>Argument Details</p> <ul> <li><strong>certificate</strong></li> <li>The master certificate to selectively reveal.</li> <li><strong>fieldsToReveal</strong></li> <li>An array of certificate field names to reveal. Only these fields will be included in the public certificate.</li> </ul> <p>Throws</p> <p>Throws an error if the certificate is invalid, the fields cannot be revealed, or if the broadcast fails.</p> <h4 id=method-removecontact_1>Method removeContact</h4> <p>Remove a contact from the contacts basket</p> <p><div class=highlight><pre><span></span><code><a id=__codelineno-10-1 name=__codelineno-10-1 href=#__codelineno-10-1></a><span class=k>public</span><span class=w> </span><span class=k>async</span><span class=w> </span><span class=nx>removeContact</span><span class=p>(</span><span class=nx>identityKey</span><span class=o>:</span><span class=w> </span><span class=kt>PubKeyHex</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=ow>void</span><span class=o>&gt;</span><span class=w> </span>
 </code></pre></div> See also: <a href=../wallet/#type-pubkeyhex>PubKeyHex</a></p> <p>Argument Details</p> <ul> <li><strong>identityKey</strong></li> <li>The identity key of the contact to remove</li> </ul> <h4 id=method-resolvebyattributes>Method resolveByAttributes</h4> <p>Resolves displayable identity certificates by specific identity attributes, issued by a trusted entity.</p> <p><div class=highlight><pre><span></span><code><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=k>async</span><span class=w> </span><span class=nx>resolveByAttributes</span><span class=p>(</span><span class=nx>args</span><span class=o>:</span><span class=w> </span><span class=kt>DiscoverByAttributesArgs</span><span class=p>,</span><span class=w> </span><span class=nx>overrideWithContacts</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=kc>true</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=nx>DisplayableIdentity</span><span class=p>[]</span><span class=o>&gt;</span><span class=w> </span>
 </code></pre></div> See also: <a href=../wallet/#interface-discoverbyattributesargs>DiscoverByAttributesArgs</a>, <a href=./#interface-displayableidentity>DisplayableIdentity</a></p> <p>Returns</p> <p>The promise resolves to displayable identities.</p> <p>Argument Details</p> <ul> <li><strong>args</strong></li> <li>Attributes and optional parameters used to discover certificates.</li> <li><strong>overrideWithContacts</strong></li> <li>Whether to override the results with personal contacts if available.</li> </ul> <h4 id=method-resolvebyidentitykey>Method resolveByIdentityKey</h4> <p>Resolves displayable identity certificates, issued to a given identity key by a trusted certifier.</p> <p><div class=highlight><pre><span></span><code><a id=__codelineno-12-1 name=__codelineno-12-1 href=#__codelineno-12-1></a><span class=k>async</span><span class=w> </span><span class=nx>resolveByIdentityKey</span><span class=p>(</span><span class=nx>args</span><span class=o>:</span><span class=w> </span><span class=kt>DiscoverByIdentityKeyArgs</span><span class=p>,</span><span class=w> </span><span class=nx>overrideWithContacts</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=kc>true</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=nx>DisplayableIdentity</span><span class=p>[]</span><span class=o>&gt;</span><span class=w> </span>
-</code></pre></div> See also: <a href=../wallet/#interface-discoverbyidentitykeyargs>DiscoverByIdentityKeyArgs</a>, <a href=./#interface-displayableidentity>DisplayableIdentity</a></p> <p>Returns</p> <p>The promise resolves to displayable identities.</p> <p>Argument Details</p> <ul> <li><strong>args</strong></li> <li>Arguments for requesting the discovery based on the identity key.</li> <li><strong>overrideWithContacts</strong></li> <li>Whether to override the results with personal contacts if available.</li> </ul> <h4 id=method-revokecertificaterevelation>Method revokeCertificateRevelation</h4> <p>Remove public certificate revelation from overlay services by spending the identity token</p> <p><div class=highlight><pre><span></span><code><a id=__codelineno-13-1 name=__codelineno-13-1 href=#__codelineno-13-1></a><span class=k>async</span><span class=w> </span><span class=nx>revokeCertificateRevelation</span><span class=p>(</span><span class=nx>serialNumber</span><span class=o>:</span><span class=w> </span><span class=kt>Base64String</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=nx>BroadcastResponse</span><span class=w> </span><span class=o>|</span><span class=w> </span><span class=nx>BroadcastFailure</span><span class=o>&gt;</span><span class=w> </span>
-</code></pre></div> See also: <a href=../wallet/#type-base64string>Base64String</a>, <a href=../transaction/#interface-broadcastfailure>BroadcastFailure</a>, <a href=../transaction/#interface-broadcastresponse>BroadcastResponse</a></p> <p>Argument Details</p> <ul> <li><strong>serialNumber</strong></li> <li>Unique serial number of the certificate to revoke revelation</li> </ul> <h4 id=method-savecontact_1>Method saveContact</h4> <p>Save or update a Metanet contact</p> <p><div class=highlight><pre><span></span><code><a id=__codelineno-14-1 name=__codelineno-14-1 href=#__codelineno-14-1></a><span class=k>public</span><span class=w> </span><span class=k>async</span><span class=w> </span><span class=nx>saveContact</span><span class=p>(</span><span class=nx>contact</span><span class=o>:</span><span class=w> </span><span class=kt>DisplayableIdentity</span><span class=p>,</span><span class=w> </span><span class=nx>metadata?</span><span class=o>:</span><span class=w> </span><span class=kt>Record</span><span class=o>&lt;</span><span class=kt>string</span><span class=p>,</span><span class=w> </span><span class=nx>any</span><span class=o>&gt;</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=ow>void</span><span class=o>&gt;</span><span class=w> </span>
+</code></pre></div> See also: <a href=../wallet/#interface-discoverbyidentitykeyargs>DiscoverByIdentityKeyArgs</a>, <a href=./#interface-displayableidentity>DisplayableIdentity</a></p> <p>Returns</p> <p>The promise resolves to displayable identities.</p> <p>Argument Details</p> <ul> <li><strong>args</strong></li> <li>Arguments for requesting the discovery based on the identity key.</li> <li><strong>overrideWithContacts</strong></li> <li>Whether to override the results with personal contacts if available.</li> </ul> <h4 id=method-revokecertificaterevelation>Method revokeCertificateRevelation</h4> <p>Remove public certificate revelation from overlay services by spending the identity token</p> <p><div class=highlight><pre><span></span><code><a id=__codelineno-13-1 name=__codelineno-13-1 href=#__codelineno-13-1></a><span class=k>async</span><span class=w> </span><span class=nx>revokeCertificateRevelation</span><span class=p>(</span><span class=nx>serialNumber</span><span class=o>:</span><span class=w> </span><span class=kt>Base64String</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=ow>void</span><span class=o>&gt;</span><span class=w> </span>
+</code></pre></div> See also: <a href=../wallet/#type-base64string>Base64String</a></p> <p>Argument Details</p> <ul> <li><strong>serialNumber</strong></li> <li>Unique serial number of the certificate to revoke revelation</li> </ul> <h4 id=method-savecontact_1>Method saveContact</h4> <p>Save or update a Metanet contact</p> <p><div class=highlight><pre><span></span><code><a id=__codelineno-14-1 name=__codelineno-14-1 href=#__codelineno-14-1></a><span class=k>public</span><span class=w> </span><span class=k>async</span><span class=w> </span><span class=nx>saveContact</span><span class=p>(</span><span class=nx>contact</span><span class=o>:</span><span class=w> </span><span class=kt>DisplayableIdentity</span><span class=p>,</span><span class=w> </span><span class=nx>metadata?</span><span class=o>:</span><span class=w> </span><span class=kt>Record</span><span class=o>&lt;</span><span class=kt>string</span><span class=p>,</span><span class=w> </span><span class=nx>any</span><span class=o>&gt;</span><span class=p>)</span><span class=o>:</span><span class=w> </span><span class=nb>Promise</span><span class=o>&lt;</span><span class=ow>void</span><span class=o>&gt;</span><span class=w> </span>
 </code></pre></div> See also: <a href=./#interface-displayableidentity>DisplayableIdentity</a></p> <p>Argument Details</p> <ul> <li><strong>contact</strong></li> <li>The displayable identity information for the contact</li> <li><strong>metadata</strong></li> <li>Optional metadata to store with the contact (ex. notes, aliases, etc)</li> </ul> <p>Links: <a href=#api>API</a>, <a href=#interfaces>Interfaces</a>, <a href=#classes>Classes</a>, <a href=#functions>Functions</a>, <a href=#types>Types</a>, <a href=#enums>Enums</a>, <a href=#variables>Variables</a></p> <hr> <h2 id=functions>Functions</h2> <h2 id=types>Types</h2> <h3 id=type-contact>Type: Contact</h3> <div class=highlight><pre><span></span><code><a id=__codelineno-15-1 name=__codelineno-15-1 href=#__codelineno-15-1></a><span class=k>export</span><span class=w> </span><span class=kr>type</span><span class=w> </span><span class=nx>Contact</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nx>DisplayableIdentity</span><span class=w> </span><span class=o>&amp;</span><span class=w> </span><span class=p>{</span>
 <a id=__codelineno-15-2 name=__codelineno-15-2 href=#__codelineno-15-2></a><span class=w>    </span><span class=nx>metadata?</span><span class=o>:</span><span class=w> </span><span class=kt>Record</span><span class=o>&lt;</span><span class=kt>string</span><span class=p>,</span><span class=w> </span><span class=nx>any</span><span class=o>&gt;</span><span class=p>;</span>
 <a id=__codelineno-15-3 name=__codelineno-15-3 href=#__codelineno-15-3></a><span class=p>}</span>