npm - @sudoplatform/sudo-secure-communications - Versions diffs - 0.0.1 → 5.0.1 - Mend

@sudoplatform/sudo-secure-communications 0.0.1 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1342) hide show

package/docs/classes/DefaultSecureCommsClient.html ADDED Viewed

@@ -0,0 +1,30 @@
+<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DefaultSecureCommsClient | @sudoplatform/sudo-secure-communications</title><meta name="description" content="Documentation for @sudoplatform/sudo-secure-communications"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@sudoplatform/sudo-secure-communications</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@sudoplatform/sudo-secure-communications</a></li><li><a href="DefaultSecureCommsClient.html">DefaultSecureCommsClient</a></li></ul><h1>Class DefaultSecureCommsClient</h1></div><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/SecureCommsClient.html" class="tsd-signature-type tsd-kind-interface">SecureCommsClient</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/secureCommsClient.ts:178</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="DefaultSecureCommsClient.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="DefaultSecureCommsClient.html#channels" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channels</span></a>
+<a href="DefaultSecureCommsClient.html#directchats" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>direct<wbr/>Chats</span></a>
+<a href="DefaultSecureCommsClient.html#groups" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>groups</span></a>
+<a href="DefaultSecureCommsClient.html#handles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handles</span></a>
+<a href="DefaultSecureCommsClient.html#media" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>media</span></a>
+<a href="DefaultSecureCommsClient.html#messaging" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>messaging</span></a>
+<a href="DefaultSecureCommsClient.html#notifications" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>notifications</span></a>
+<a href="DefaultSecureCommsClient.html#security" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>security</span></a>
+<a href="DefaultSecureCommsClient.html#storage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>storage</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="DefaultSecureCommsClient.html#isready" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Ready</span></a>
+<a href="DefaultSecureCommsClient.html#reset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a>
+<a href="DefaultSecureCommsClient.html#startsyncing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Syncing</span></a>
+<a href="DefaultSecureCommsClient.html#stopsyncing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Syncing</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructordefaultsecurecommsclient" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultSecureCommsClient</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">:</span> <a href="../types/SecureCommsClientOptions.html" class="tsd-signature-type tsd-kind-type-alias">SecureCommsClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="DefaultSecureCommsClient.html" class="tsd-signature-type tsd-kind-class">DefaultSecureCommsClient</a><a href="#constructordefaultsecurecommsclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">opts</span>: <a href="../types/SecureCommsClientOptions.html" class="tsd-signature-type tsd-kind-type-alias">SecureCommsClientOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="DefaultSecureCommsClient.html" class="tsd-signature-type tsd-kind-class">DefaultSecureCommsClient</a></h4><aside class="tsd-sources"><ul><li>Defined in src/public/secureCommsClient.ts:202</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="channels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>channels</span><a href="#channels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">channels</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ChannelsModule.html" class="tsd-signature-type tsd-kind-interface">ChannelsModule</a></div><div class="tsd-comment tsd-typography"><p>Accessor for the Channels sub-module.</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#channels">channels</a></p><ul><li>Defined in src/public/secureCommsClient.ts:182</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="directchats" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>direct<wbr/>Chats</span><a href="#directchats" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">directChats</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DirectChatsModule.html" class="tsd-signature-type tsd-kind-interface">DirectChatsModule</a></div><div class="tsd-comment tsd-typography"><p>Accessor for the Direct Chats sub-module.</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#directchats">directChats</a></p><ul><li>Defined in src/public/secureCommsClient.ts:180</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="groups" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>groups</span><a href="#groups" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">groups</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GroupsModule.html" class="tsd-signature-type tsd-kind-interface">GroupsModule</a></div><div class="tsd-comment tsd-typography"><p>Accessor for the Groups sub-module.</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#groups">groups</a></p><ul><li>Defined in src/public/secureCommsClient.ts:181</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="handles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>handles</span><a href="#handles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">handles</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/HandlesModule.html" class="tsd-signature-type tsd-kind-interface">HandlesModule</a></div><div class="tsd-comment tsd-typography"><p>Accessor for the Handles sub-module.</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#handles">handles</a></p><ul><li>Defined in src/public/secureCommsClient.ts:179</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="media" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>media</span><a href="#media" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">media</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/MediaModule.html" class="tsd-signature-type tsd-kind-interface">MediaModule</a></div><div class="tsd-comment tsd-typography"><p>Accessor for the Media sub-module.</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#media">media</a></p><ul><li>Defined in src/public/secureCommsClient.ts:184</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="messaging" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>messaging</span><a href="#messaging" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">messaging</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/MessagingModule.html" class="tsd-signature-type tsd-kind-interface">MessagingModule</a></div><div class="tsd-comment tsd-typography"><p>Accessor for the Messaging sub-module.</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#messaging">messaging</a></p><ul><li>Defined in src/public/secureCommsClient.ts:183</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="notifications" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>notifications</span><a href="#notifications" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">notifications</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/NotificationsModule.html" class="tsd-signature-type tsd-kind-interface">NotificationsModule</a></div><div class="tsd-comment tsd-typography"><p>Accessor for the Notifications sub-module.</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#notifications">notifications</a></p><ul><li>Defined in src/public/secureCommsClient.ts:186</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="security" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>security</span><a href="#security" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">security</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SecurityModule.html" class="tsd-signature-type tsd-kind-interface">SecurityModule</a></div><div class="tsd-comment tsd-typography"><p>Accessor for the Security sub-module.</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#security">security</a></p><ul><li>Defined in src/public/secureCommsClient.ts:185</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="storage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>storage</span><a href="#storage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">storage</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/StorageModule.html" class="tsd-signature-type tsd-kind-interface">StorageModule</a></div><div class="tsd-comment tsd-typography"><p>Accessor for the Storage sub-module.</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#storage">storage</a></p><ul><li>Defined in src/public/secureCommsClient.ts:187</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="isready" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Ready</span><a href="#isready" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="isready-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isReady</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#isready-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if the client has finished the initial sync and is ready for use.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>True if the client is ready for use, false if not.</p>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#isready">isReady</a></p><ul><li>Defined in src/public/secureCommsClient.ts:279</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="reset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reset</span><a href="#reset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="reset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reset</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes any cached data maintained by this client.</p>
+</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#reset">reset</a></p><ul><li>Defined in src/public/secureCommsClient.ts:289</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="startsyncing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Syncing</span><a href="#startsyncing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="startsyncing-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">startSyncing</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#startsyncing-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Start syncing in the background for data updates.</p>
+<p>Can only be called after sign-in creation of a handle.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#startsyncing">startSyncing</a></p><ul><li>Defined in src/public/secureCommsClient.ts:270</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="stopsyncing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stop<wbr/>Syncing</span><a href="#stopsyncing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="stopsyncing-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stopSyncing</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#stopsyncing-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stop syncing.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecureCommsClient.html">SecureCommsClient</a>.<a href="../interfaces/SecureCommsClient.html#stopsyncing">stopSyncing</a></p><ul><li>Defined in src/public/secureCommsClient.ts:284</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#channels" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channels</span></a><a href="#directchats" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>direct<wbr/>Chats</span></a><a href="#groups" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>groups</span></a><a href="#handles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handles</span></a><a href="#media" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>media</span></a><a href="#messaging" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>messaging</span></a><a href="#notifications" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>notifications</span></a><a href="#security" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>security</span></a><a href="#storage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>storage</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#isready" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Ready</span></a><a href="#reset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a><a href="#startsyncing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Syncing</span></a><a href="#stopsyncing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Syncing</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-secure-communications</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/classes/DefaultSecurityModule.html ADDED Viewed

@@ -0,0 +1,81 @@
+<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DefaultSecurityModule | @sudoplatform/sudo-secure-communications</title><meta name="description" content="Documentation for @sudoplatform/sudo-secure-communications"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@sudoplatform/sudo-secure-communications</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@sudoplatform/sudo-secure-communications</a></li><li><a href="DefaultSecurityModule.html">DefaultSecurityModule</a></li></ul><h1>Class DefaultSecurityModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Key backup, restore and interactive device verification services.</p>
+<p>In the secure communications offering, each device stores their own keys.
+To seamlessly continue conversations across multiple devices,
+the keys must be replicated across those devices.
+Verified devices automatically remain in sync with each others keys, so it's
+important to design apps that encourage users to keep their devices verified.</p>
+<p>Client can verify devices with two mechanisms:</p>
+<ol>
+<li>
+<p>Key backup and restore. In this method, client keys are encrypted with a
+&quot;backup key&quot; and uploaded to the server. The keys can later be &quot;recovered&quot;
+on other devices using the same backup key. This backup gives the device
+access to other previous session keys.</p>
+</li>
+<li>
+<p>Interactive verification. In this method, two devices can verify their keys
+out of band using emoji matching. In the case tha verification is happening between
+the same handle of two different devices, the unverified device becomes verified
+and will then gain access to session keys from their other devices.</p>
+</li>
+</ol>
+</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/SecurityModule.html" class="tsd-signature-type tsd-kind-interface">SecurityModule</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:331</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="DefaultSecurityModule.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="DefaultSecurityModule.html#acceptverificationrequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>accept<wbr/>Verification<wbr/>Request</span></a>
+<a href="DefaultSecurityModule.html#approveverification" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>approve<wbr/>Verification</span></a>
+<a href="DefaultSecurityModule.html#cancelverification" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Verification</span></a>
+<a href="DefaultSecurityModule.html#createbackup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Backup</span></a>
+<a href="DefaultSecurityModule.html#declineverification" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>decline<wbr/>Verification</span></a>
+<a href="DefaultSecurityModule.html#getbackupstate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Backup<wbr/>State</span></a>
+<a href="DefaultSecurityModule.html#isverified" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Verified</span></a>
+<a href="DefaultSecurityModule.html#onsessionverificationchanged" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Session<wbr/>Verification<wbr/>Changed</span></a>
+<a href="DefaultSecurityModule.html#onverificationrequestreceived" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Verification<wbr/>Request<wbr/>Received</span></a>
+<a href="DefaultSecurityModule.html#recover" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>recover</span></a>
+<a href="DefaultSecurityModule.html#requestverification" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Verification</span></a>
+<a href="DefaultSecurityModule.html#resetbackupkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Backup<wbr/>Key</span></a>
+<a href="DefaultSecurityModule.html#rotatebackupkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rotate<wbr/>Backup<wbr/>Key</span></a>
+<a href="DefaultSecurityModule.html#startverification" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Verification</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructordefaultsecuritymodule" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultSecurityModule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sessionManager</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SessionManager</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="DefaultSecurityModule.html" class="tsd-signature-type tsd-kind-class">DefaultSecurityModule</a><a href="#constructordefaultsecuritymodule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">sessionManager</span>: <span class="tsd-signature-type">SessionManager</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="DefaultSecurityModule.html" class="tsd-signature-type tsd-kind-class">DefaultSecurityModule</a></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:334</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="acceptverificationrequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>accept<wbr/>Verification<wbr/>Request</span><a href="#acceptverificationrequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="acceptverificationrequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">acceptVerificationRequest</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AcceptVerificationRequestInput.html" class="tsd-signature-type tsd-kind-interface">AcceptVerificationRequestInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#acceptverificationrequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Accept a verification request from another device.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/AcceptVerificationRequestInput.html" class="tsd-signature-type tsd-kind-interface">AcceptVerificationRequestInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the accept verification request method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#acceptverificationrequest">acceptVerificationRequest</a></p><ul><li>Defined in src/public/modules/securityModule.ts:416</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="approveverification" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>approve<wbr/>Verification</span><a href="#approveverification" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="approveverification-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">approveVerification</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ApproveVerificationInput.html" class="tsd-signature-type tsd-kind-interface">ApproveVerificationInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#approveverification-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Approve a verification request. Users must check the contents of the [InteractiveVerificationState.ReceivedVerificationData]
+to ensure the emojis match before approving.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/ApproveVerificationInput.html" class="tsd-signature-type tsd-kind-interface">ApproveVerificationInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the approve verification method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#approveverification">approveVerification</a></p><ul><li>Defined in src/public/modules/securityModule.ts:432</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="cancelverification" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cancel<wbr/>Verification</span><a href="#cancelverification" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="cancelverification-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">cancelVerification</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CancelVerificationInput.html" class="tsd-signature-type tsd-kind-interface">CancelVerificationInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#cancelverification-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Cancel the current verification at any time.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/CancelVerificationInput.html" class="tsd-signature-type tsd-kind-interface">CancelVerificationInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the cancel verification method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#cancelverification">cancelVerification</a></p><ul><li>Defined in src/public/modules/securityModule.ts:450</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="createbackup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Backup</span><a href="#createbackup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="createbackup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createBackup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CreateBackupInput.html" class="tsd-signature-type tsd-kind-interface">CreateBackupInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#createbackup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a server-side, encrypted backup of client keys for the user.
+After creation, keys are automatically uploaded to the backup so this
+only has to be called once.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/CreateBackupInput.html" class="tsd-signature-type tsd-kind-interface">CreateBackupInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the create backup method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a backup key, to be used with the [recover] method to recover keys from the server backup.</p>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#createbackup">createBackup</a></p><ul><li>Defined in src/public/modules/securityModule.ts:366</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="declineverification" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>decline<wbr/>Verification</span><a href="#declineverification" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="declineverification-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">declineVerification</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DeclineVerificationInput.html" class="tsd-signature-type tsd-kind-interface">DeclineVerificationInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#declineverification-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Decline a verification request.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/DeclineVerificationInput.html" class="tsd-signature-type tsd-kind-interface">DeclineVerificationInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the decline verification method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#declineverification">declineVerification</a></p><ul><li>Defined in src/public/modules/securityModule.ts:441</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getbackupstate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Backup<wbr/>State</span><a href="#getbackupstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getbackupstate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getBackupState</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GetBackupStateInput.html" class="tsd-signature-type tsd-kind-interface">GetBackupStateInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/BackupState.html" class="tsd-signature-type tsd-kind-enum">BackupState</a><span class="tsd-signature-symbol">&gt;</span><a href="#getbackupstate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the current state of the encrypted server backup.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/GetBackupStateInput.html" class="tsd-signature-type tsd-kind-interface">GetBackupStateInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the get backup state method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/BackupState.html" class="tsd-signature-type tsd-kind-enum">BackupState</a><span class="tsd-signature-symbol">&gt;</span></h4><p>the current backup state</p>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#getbackupstate">getBackupState</a></p><ul><li>Defined in src/public/modules/securityModule.ts:357</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="isverified" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Verified</span><a href="#isverified" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="isverified-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isVerified</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IsVerifiedInput.html" class="tsd-signature-type tsd-kind-interface">IsVerifiedInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#isverified-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convenience method to check if the current session is verified.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/IsVerifiedInput.html" class="tsd-signature-type tsd-kind-interface">IsVerifiedInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the isVerified method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>true if the current session is verified, false otherwise</p>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#isverified">isVerified</a></p><ul><li>Defined in src/public/modules/securityModule.ts:338</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="onsessionverificationchanged" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Session<wbr/>Verification<wbr/>Changed</span><a href="#onsessionverificationchanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="onsessionverificationchanged-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onSessionVerificationChanged</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/OnSessionVerificationChangedInput.html" class="tsd-signature-type tsd-kind-interface">OnSessionVerificationChangedInput</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#onsessionverificationchanged-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get notified when the state of the session verification changes.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/OnSessionVerificationChangedInput.html" class="tsd-signature-type tsd-kind-interface">OnSessionVerificationChangedInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the onSessionVerificationChanged method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#onsessionverificationchanged">onSessionVerificationChanged</a></p><ul><li>Defined in src/public/modules/securityModule.ts:345</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="onverificationrequestreceived" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Verification<wbr/>Request<wbr/>Received</span><a href="#onverificationrequestreceived" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="onverificationrequestreceived-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onVerificationRequestReceived</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/OnVerificationRequestReceivedInput.html" class="tsd-signature-type tsd-kind-interface">OnVerificationRequestReceivedInput</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#onverificationrequestreceived-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Register a callback to be notified when a verification request is received.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/OnVerificationRequestReceivedInput.html" class="tsd-signature-type tsd-kind-interface">OnVerificationRequestReceivedInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the on verification request received method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#onverificationrequestreceived">onVerificationRequestReceived</a></p><ul><li>Defined in src/public/modules/securityModule.ts:396</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="recover" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>recover</span><a href="#recover" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="recover-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">recover</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/RecoverInput.html" class="tsd-signature-type tsd-kind-interface">RecoverInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#recover-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Recover client keys from a server-side backup.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/RecoverInput.html" class="tsd-signature-type tsd-kind-interface">RecoverInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the recover method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#recover">recover</a></p><ul><li>Defined in src/public/modules/securityModule.ts:373</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="requestverification" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>Verification</span><a href="#requestverification" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="requestverification-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">requestVerification</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/RequestVerificationInput.html" class="tsd-signature-type tsd-kind-interface">RequestVerificationInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#requestverification-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Begin an interactive verification flow by requesting verification to
+another verified, online device.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/RequestVerificationInput.html" class="tsd-signature-type tsd-kind-interface">RequestVerificationInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the request verification method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#requestverification">requestVerification</a></p><ul><li>Defined in src/public/modules/securityModule.ts:407</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="resetbackupkey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reset<wbr/>Backup<wbr/>Key</span><a href="#resetbackupkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="resetbackupkey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">resetBackupKey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ResetBackupKeyInput.html" class="tsd-signature-type tsd-kind-interface">ResetBackupKeyInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#resetbackupkey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Resets the backup. This replaces the server side backup with current keys known to
+this device. This will result in data loss of previous messages encrypted with keys
+from the previous backup not known to this device. All other devices associated
+with this user will become unverified.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/ResetBackupKeyInput.html" class="tsd-signature-type tsd-kind-interface">ResetBackupKeyInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the reset backup method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a new backup key, to be used with the [recover] method to recover
+keys from the server backup.</p>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#resetbackupkey">resetBackupKey</a></p><ul><li>Defined in src/public/modules/securityModule.ts:387</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="rotatebackupkey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rotate<wbr/>Backup<wbr/>Key</span><a href="#rotatebackupkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="rotatebackupkey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">rotateBackupKey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/RotateBackupKeyInput.html" class="tsd-signature-type tsd-kind-interface">RotateBackupKeyInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#rotatebackupkey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Rotate backup keys. The previous backup key is invalidated and replaced with a new one.
+Only verified sessions can execute this command.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/RotateBackupKeyInput.html" class="tsd-signature-type tsd-kind-interface">RotateBackupKeyInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the rotate backup key method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a new backup key, to be used with the [recover] method to recover
+keys from the server backup.</p>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#rotatebackupkey">rotateBackupKey</a></p><ul><li>Defined in src/public/modules/securityModule.ts:380</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="startverification" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Verification</span><a href="#startverification" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="startverification-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">startVerification</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/StartVerificationInput.html" class="tsd-signature-type tsd-kind-interface">StartVerificationInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#startverification-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Start interactive verification. This can only occur after the other device
+has accepted the verification request. Either device can start the verification.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/StartVerificationInput.html" class="tsd-signature-type tsd-kind-interface">StartVerificationInput</a></span><div class="tsd-comment tsd-typography"><p>the input for the start verification method</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SecurityModule.html">SecurityModule</a>.<a href="../interfaces/SecurityModule.html#startverification">startVerification</a></p><ul><li>Defined in src/public/modules/securityModule.ts:425</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#acceptverificationrequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>accept<wbr/>Verification<wbr/>Request</span></a><a href="#approveverification" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>approve<wbr/>Verification</span></a><a href="#cancelverification" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Verification</span></a><a href="#createbackup" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Backup</span></a><a href="#declineverification" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>decline<wbr/>Verification</span></a><a href="#getbackupstate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Backup<wbr/>State</span></a><a href="#isverified" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Verified</span></a><a href="#onsessionverificationchanged" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Session<wbr/>Verification<wbr/>Changed</span></a><a href="#onverificationrequestreceived" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Verification<wbr/>Request<wbr/>Received</span></a><a href="#recover" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>recover</span></a><a href="#requestverification" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Verification</span></a><a href="#resetbackupkey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Backup<wbr/>Key</span></a><a href="#rotatebackupkey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rotate<wbr/>Backup<wbr/>Key</span></a><a href="#startverification" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Verification</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-secure-communications</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/classes/DefaultStorageModule.html ADDED Viewed

@@ -0,0 +1,24 @@
+<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DefaultStorageModule | @sudoplatform/sudo-secure-communications</title><meta name="description" content="Documentation for @sudoplatform/sudo-secure-communications"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@sudoplatform/sudo-secure-communications</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@sudoplatform/sudo-secure-communications</a></li><li><a href="DefaultStorageModule.html">DefaultStorageModule</a></li></ul><h1>Class DefaultStorageModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The <code>StorageModule</code> is capable of managing multiple user sessions, ensuring data isolation across different handles (sessions).</p>
+<p>It should be storage-backend-agnostic to allow using the SDK in browser, Node.js or other environments with different storage requirements and capabilities.</p>
+</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/StorageModule.html" class="tsd-signature-type tsd-kind-interface">StorageModule</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/storageModule.ts:210</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="DefaultStorageModule.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="DefaultStorageModule.html#closehandlestorage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close<wbr/>Handle<wbr/>Storage</span></a>
+<a href="DefaultStorageModule.html#deletehandlestorage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Handle<wbr/>Storage</span></a>
+<a href="DefaultStorageModule.html#usehandlestorage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>use<wbr/>Handle<wbr/>Storage</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructordefaultstoragemodule" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultStorageModule</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">storageProviderFactory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/StorageProviderFactory.html" class="tsd-signature-type tsd-kind-interface">StorageProviderFactory</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="DefaultStorageModule.html" class="tsd-signature-type tsd-kind-class">DefaultStorageModule</a><a href="#constructordefaultstoragemodule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">storageProviderFactory</span>: <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/StorageProviderFactory.html" class="tsd-signature-type tsd-kind-interface">StorageProviderFactory</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="DefaultStorageModule.html" class="tsd-signature-type tsd-kind-class">DefaultStorageModule</a></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/storageModule.ts:216</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="closehandlestorage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>close<wbr/>Handle<wbr/>Storage</span><a href="#closehandlestorage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="closehandlestorage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">closeHandleStorage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#closehandlestorage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><code>closeHandleStorage</code> when called, the associated HandleStorage object is removed from the cache, but data is not purged from storage.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handleId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The handleId of the handle to close a storage for.</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/StorageModule.html">StorageModule</a>.<a href="../interfaces/StorageModule.html#closehandlestorage">closeHandleStorage</a></p><ul><li>Defined in src/public/modules/storageModule.ts:249</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="deletehandlestorage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Handle<wbr/>Storage</span><a href="#deletehandlestorage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="deletehandlestorage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteHandleStorage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#deletehandlestorage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><code>deleteHandleStorage</code> when called, the associated HandleStorage object is removed from the cache, and any data is purged from storage.</p>
+<p>Used for clearing data from storage when signing out.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handleId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The handleId of the handle to delete a storage for.</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/StorageModule.html">StorageModule</a>.<a href="../interfaces/StorageModule.html#deletehandlestorage">deleteHandleStorage</a></p><ul><li>Defined in src/public/modules/storageModule.ts:256</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="usehandlestorage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>use<wbr/>Handle<wbr/>Storage</span><a href="#usehandlestorage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="usehandlestorage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">useHandleStorage</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">storePassphrase</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/HandleStorage.html" class="tsd-signature-type tsd-kind-interface">HandleStorage</a><span class="tsd-signature-symbol">&gt;</span><a href="#usehandlestorage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><code>useHandleStorage</code> is responsible for opening (creating new storage or constructing object for existing storage), caching and returning HandleStorage objects for each handleId.</p>
+<p>Each handle gets their dedicated HandleStorage object, which helps segmenting data from different sessions.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handleId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The handleId of the handle to get a storage for.</p>
+</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">storePassphrase</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>(optional) The passphrase to use for the storage.</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/HandleStorage.html" class="tsd-signature-type tsd-kind-interface">HandleStorage</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
+<li>The HandleStorage object for the handleId. If the storage provider is not available, <code>undefined</code> is returned.</li>
+</ul>
+<hr>
+<p><em><strong>⚠️ WARNING ⚠️</strong></em></p>
+<p>If <code>storePassphrase</code> is <strong>not</strong> provided when the storage handle is <strong>first created</strong>, the local storage will be <strong>UNENCRYPTED</strong>.</p>
+<p>To enable encryption, <code>storePassphrase</code> <strong>must</strong> be passed on the <strong>very first call</strong> to this function — i.e., the first time this handle is initialized on a device.</p>
+<p>⚠️ Once the storage has been initialized <strong>without encryption</strong>, it <strong>CANNOT</strong> be encrypted later by simply providing <code>storePassphrase</code>. Doing so will lead to <strong>storage malfunction</strong>. If this happens, you <strong>must delete</strong> the existing storage and <strong>recreate</strong> it with <code>storePassphrase</code> provided from the start.</p>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/StorageModule.html">StorageModule</a>.<a href="../interfaces/StorageModule.html#usehandlestorage">useHandleStorage</a></p><ul><li>Defined in src/public/modules/storageModule.ts:221</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#closehandlestorage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close<wbr/>Handle<wbr/>Storage</span></a><a href="#deletehandlestorage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Handle<wbr/>Storage</span></a><a href="#usehandlestorage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>use<wbr/>Handle<wbr/>Storage</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-secure-communications</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>