@sudoplatform/sudo-secure-communications 5.1.2 → 5.1.4
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.
- package/cjs/private/data/common/apiClient.js +20 -34
- package/cjs/private/data/common/apiClient.js.map +1 -1
- package/cjs/private/data/common/transformer/errorTransformer.js +5 -3
- package/cjs/private/data/common/transformer/errorTransformer.js.map +1 -1
- package/cjs/private/data/messaging/matrixMessagingService.js +6 -1
- package/cjs/private/data/messaging/matrixMessagingService.js.map +1 -1
- package/cjs/private/data/session/sessionManager.js +2 -2
- package/cjs/private/data/session/sessionManager.js.map +1 -1
- package/cjs/public/errors.js +9 -3
- package/cjs/public/errors.js.map +1 -1
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/main.js +5 -5
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +248 -226
- package/docs/classes/AliasNotAvailableError.html +12 -12
- package/docs/classes/ChannelId.html +7 -7
- package/docs/classes/ChannelNameNotAvailableError.html +12 -12
- package/docs/classes/ChannelNotFoundError.html +12 -12
- package/docs/classes/ChannelPermissions.html +21 -21
- package/docs/classes/ChatId.html +7 -7
- package/docs/classes/DefaultChannelsModule.html +66 -66
- package/docs/classes/DefaultDirectChatsModule.html +23 -23
- package/docs/classes/DefaultGroupsModule.html +44 -44
- package/docs/classes/DefaultHandlesModule.html +13 -13
- package/docs/classes/DefaultMediaModule.html +6 -6
- package/docs/classes/DefaultMessagingModule.html +51 -51
- package/docs/classes/DefaultNotificationsModule.html +17 -17
- package/docs/classes/DefaultSecureCommsClient.html +28 -28
- package/docs/classes/DefaultSecurityModule.html +36 -36
- package/docs/classes/DefaultStorageModule.html +11 -11
- package/docs/classes/DirectChatExistsError.html +12 -12
- package/docs/classes/DirectChatMembershipError.html +12 -12
- package/docs/classes/DirectChatPermissions.html +7 -7
- package/docs/classes/GroupId.html +7 -7
- package/docs/classes/GroupPermissions.html +21 -21
- package/docs/classes/HandleId.html +5 -5
- package/docs/classes/HandleNotAvailableError.html +12 -12
- package/docs/classes/HandleNotFoundError.html +12 -12
- package/docs/classes/IndexedDBStorageProviderFactory.html +3 -3
- package/docs/classes/InternalError.html +12 -12
- package/docs/classes/InvalidArgumentError.html +12 -12
- package/docs/classes/InvalidChannelAliasError.html +12 -12
- package/docs/classes/InvalidChannelStateError.html +12 -12
- package/docs/classes/InvalidHandleIdError.html +33 -0
- package/docs/classes/InvalidHandleNameError.html +33 -0
- package/docs/classes/NotAllowedError.html +12 -12
- package/docs/classes/PermissionDeniedError.html +12 -12
- package/docs/classes/RoomNotFoundError.html +12 -12
- package/docs/classes/S3DownloadError.html +13 -13
- package/docs/classes/S3UploadError.html +13 -13
- package/docs/classes/SecureCommsError.html +12 -12
- package/docs/classes/SecureCommsServiceConfigNotFoundError.html +12 -12
- package/docs/classes/UnacceptableWordsError.html +12 -12
- package/docs/classes/UnauthorizedError.html +12 -12
- package/docs/enums/BackupState.html +6 -6
- package/docs/enums/ChannelJoinRule.html +5 -5
- package/docs/enums/ChannelRole.html +6 -6
- package/docs/enums/ChannelSortDirection.html +4 -4
- package/docs/enums/ChannelSortField.html +4 -4
- package/docs/enums/DirectChatRole.html +4 -4
- package/docs/enums/GroupRole.html +5 -5
- package/docs/enums/MembershipState.html +7 -7
- package/docs/enums/MessageNotificationLevel.html +4 -4
- package/docs/enums/MessageState.html +5 -5
- package/docs/enums/NotificationInfoType.html +3 -3
- package/docs/enums/PollType.html +4 -4
- package/docs/enums/PublicChannelJoinRule.html +4 -4
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +5 -5
- package/docs/interfaces/AcceptChannelInvitationInput.html +6 -6
- package/docs/interfaces/AcceptGroupInvitationInput.html +6 -6
- package/docs/interfaces/AcceptInvitationInput.html +6 -6
- package/docs/interfaces/AcceptInvitationRequestInput.html +8 -8
- package/docs/interfaces/AcceptVerificationRequestInput.html +8 -8
- package/docs/interfaces/ApproveVerificationInput.html +4 -4
- package/docs/interfaces/Audio.html +13 -13
- package/docs/interfaces/AudioMedia.html +7 -7
- package/docs/interfaces/AvatarInput.html +8 -8
- package/docs/interfaces/BanChannelHandleInput.html +9 -9
- package/docs/interfaces/BanGroupHandleInput.html +10 -10
- package/docs/interfaces/BaseMessageContent.html +10 -10
- package/docs/interfaces/BlockHandleInput.html +6 -6
- package/docs/interfaces/CancelVerificationInput.html +4 -4
- package/docs/interfaces/Channel.html +24 -24
- package/docs/interfaces/ChannelInvitationRequest.html +10 -10
- package/docs/interfaces/ChannelInvite.html +5 -5
- package/docs/interfaces/ChannelMember.html +8 -8
- package/docs/interfaces/ChannelPermissionsInput.html +10 -10
- package/docs/interfaces/ChannelSortOrder.html +6 -6
- package/docs/interfaces/ChannelsModule.html +65 -65
- package/docs/interfaces/ChatMention.html +4 -4
- package/docs/interfaces/ChatNotificationRules.html +2 -2
- package/docs/interfaces/ChatSummary.html +12 -12
- package/docs/interfaces/ClearRecipientChatRulesInput.html +6 -6
- package/docs/interfaces/CreateBackupInput.html +4 -4
- package/docs/interfaces/CreateChannelInput.html +20 -20
- package/docs/interfaces/CreateChatInput.html +6 -6
- package/docs/interfaces/CreateGroupInput.html +12 -12
- package/docs/interfaces/CreatePollInput.html +14 -14
- package/docs/interfaces/DeclineChannelInvitationInput.html +6 -6
- package/docs/interfaces/DeclineGroupInvitationInput.html +6 -6
- package/docs/interfaces/DeclineInvitationInput.html +6 -6
- package/docs/interfaces/DeclineInvitationRequestInput.html +10 -10
- package/docs/interfaces/DeclineVerificationInput.html +4 -4
- package/docs/interfaces/DeleteChannelInput.html +5 -5
- package/docs/interfaces/DeleteGroupInput.html +6 -6
- package/docs/interfaces/DeleteMessageInput.html +10 -10
- package/docs/interfaces/DeleteOwnRedactReason.html +6 -6
- package/docs/interfaces/DirectChat.html +6 -6
- package/docs/interfaces/DirectChatInvitation.html +6 -6
- package/docs/interfaces/DirectChatInvite.html +5 -5
- package/docs/interfaces/DirectChatsModule.html +22 -22
- package/docs/interfaces/DownloadMediaFileInput.html +10 -10
- package/docs/interfaces/EditMessageInput.html +10 -10
- package/docs/interfaces/EditPollInput.html +16 -16
- package/docs/interfaces/EditReactionRedactReason.html +4 -4
- package/docs/interfaces/Emote.html +9 -9
- package/docs/interfaces/EncryptedMessage.html +7 -7
- package/docs/interfaces/EndPollInput.html +8 -8
- package/docs/interfaces/EventListenerContent.html +8 -8
- package/docs/interfaces/EventListenerReaction.html +10 -10
- package/docs/interfaces/EventNotificationRules.html +2 -2
- package/docs/interfaces/File.html +13 -13
- package/docs/interfaces/FileEncryptionInfo.html +10 -10
- package/docs/interfaces/FileMedia.html +5 -5
- package/docs/interfaces/GetBackupStateInput.html +4 -4
- package/docs/interfaces/GetChannelInput.html +6 -6
- package/docs/interfaces/GetChannelMembersInput.html +6 -6
- package/docs/interfaces/GetChannelMembershipInput.html +6 -6
- package/docs/interfaces/GetChannelsInput.html +6 -6
- package/docs/interfaces/GetChatSummariesInput.html +6 -6
- package/docs/interfaces/GetDecodedInfoInput.html +8 -8
- package/docs/interfaces/GetGroupInput.html +6 -6
- package/docs/interfaces/GetGroupMembersInput.html +6 -6
- package/docs/interfaces/GetGroupsInput.html +6 -6
- package/docs/interfaces/GetMessageInput.html +8 -8
- package/docs/interfaces/GetMessagesInput.html +10 -10
- package/docs/interfaces/GetPinnedMessagesInput.html +6 -6
- package/docs/interfaces/GetPollResponsesInput.html +8 -8
- package/docs/interfaces/GetSettingsInput.html +4 -4
- package/docs/interfaces/Group.html +14 -14
- package/docs/interfaces/GroupInvite.html +5 -5
- package/docs/interfaces/GroupMember.html +8 -8
- package/docs/interfaces/GroupsModule.html +43 -43
- package/docs/interfaces/Handle.html +6 -6
- package/docs/interfaces/HandleMention.html +8 -8
- package/docs/interfaces/HandleStorage.html +6 -6
- package/docs/interfaces/HandlesModule.html +12 -12
- package/docs/interfaces/HashAlgorithmMap.html +4 -4
- package/docs/interfaces/Image.html +19 -19
- package/docs/interfaces/ImageMedia.html +9 -9
- package/docs/interfaces/Input.html +3 -3
- package/docs/interfaces/Invite.html +4 -4
- package/docs/interfaces/IsVerifiedInput.html +4 -4
- package/docs/interfaces/JoinChannelInput.html +6 -6
- package/docs/interfaces/KeyVerificationRequest.html +18 -18
- package/docs/interfaces/KickChannelHandleInput.html +10 -10
- package/docs/interfaces/KickGroupHandleInput.html +10 -10
- package/docs/interfaces/LeaveChannelInput.html +6 -6
- package/docs/interfaces/LeaveGroupInput.html +6 -6
- package/docs/interfaces/ListHandlesInput.html +6 -6
- package/docs/interfaces/ListReceivedInvitationRequestsInput.html +6 -6
- package/docs/interfaces/Location.html +11 -11
- package/docs/interfaces/MarkAsReadInput.html +6 -6
- package/docs/interfaces/MediaModule.html +5 -5
- package/docs/interfaces/Member.html +6 -6
- package/docs/interfaces/MembershipChange.html +14 -14
- package/docs/interfaces/Message.html +20 -20
- package/docs/interfaces/MessageNotification.html +5 -5
- package/docs/interfaces/MessageReaction.html +8 -8
- package/docs/interfaces/MessageReceipt.html +6 -6
- package/docs/interfaces/MessagingModule.html +50 -50
- package/docs/interfaces/ModerationRedactReason.html +10 -10
- package/docs/interfaces/Notice.html +9 -9
- package/docs/interfaces/NotificationInfo.html +4 -4
- package/docs/interfaces/NotificationSettings.html +4 -4
- package/docs/interfaces/NotificationsModule.html +16 -16
- package/docs/interfaces/OnSessionVerificationChangedInput.html +6 -6
- package/docs/interfaces/OnVerificationRequestReceivedInput.html +6 -6
- package/docs/interfaces/OwnedHandle.html +10 -10
- package/docs/interfaces/Pagination.html +6 -6
- package/docs/interfaces/PinMessageInput.html +8 -8
- package/docs/interfaces/PlatformNotificationDataTemplate.html +6 -6
- package/docs/interfaces/Poll.html +15 -15
- package/docs/interfaces/PollResponse.html +11 -11
- package/docs/interfaces/PollResponses.html +8 -8
- package/docs/interfaces/ProvisionHandleInput.html +8 -8
- package/docs/interfaces/PublicChannelSearchInput.html +18 -18
- package/docs/interfaces/PublicChannelSearchResult.html +20 -20
- package/docs/interfaces/Recipient.html +4 -4
- package/docs/interfaces/RecoverInput.html +6 -6
- package/docs/interfaces/RedactedMessage.html +12 -12
- package/docs/interfaces/RegisterMessageListenerInput.html +10 -10
- package/docs/interfaces/RequestVerificationInput.html +4 -4
- package/docs/interfaces/ResetBackupKeyInput.html +4 -4
- package/docs/interfaces/RotateBackupKeyInput.html +4 -4
- package/docs/interfaces/SearchMessagesInput.html +10 -10
- package/docs/interfaces/SearchMessagesItem.html +18 -18
- package/docs/interfaces/SecureCommsClient.html +28 -28
- package/docs/interfaces/SecureCommsSession.html +18 -18
- package/docs/interfaces/SecureCommsStore.html +8 -8
- package/docs/interfaces/SecurityModule.html +35 -35
- package/docs/interfaces/SelfDestructInfo.html +8 -8
- package/docs/interfaces/SelfDestructedMessage.html +10 -10
- package/docs/interfaces/SendChannelInvitationsInput.html +8 -8
- package/docs/interfaces/SendGroupInvitationsInput.html +8 -8
- package/docs/interfaces/SendInvitationRequestInput.html +8 -8
- package/docs/interfaces/SendMediaInput.html +26 -26
- package/docs/interfaces/SendMessageInput.html +18 -18
- package/docs/interfaces/SendPollResponseInput.html +10 -10
- package/docs/interfaces/SendTypingNotificationInput.html +8 -8
- package/docs/interfaces/SessionAPIs.html +5 -5
- package/docs/interfaces/SetDefaultChatRulesInput.html +6 -6
- package/docs/interfaces/SetDefaultEventRulesInput.html +6 -6
- package/docs/interfaces/SetRecipientChatRulesInput.html +8 -8
- package/docs/interfaces/StartVerificationInput.html +4 -4
- package/docs/interfaces/StorageModule.html +10 -10
- package/docs/interfaces/StorageProvider.html +32 -32
- package/docs/interfaces/StorageProviderFactory.html +2 -2
- package/docs/interfaces/Text.html +9 -9
- package/docs/interfaces/ThumbnailInfo.html +12 -12
- package/docs/interfaces/ToggleReactionInput.html +10 -10
- package/docs/interfaces/UnbanChannelHandleInput.html +9 -9
- package/docs/interfaces/UnbanGroupHandleInput.html +10 -10
- package/docs/interfaces/UnblockHandleInput.html +6 -6
- package/docs/interfaces/UnknownRedactReason.html +4 -4
- package/docs/interfaces/UnpinMessageInput.html +8 -8
- package/docs/interfaces/UnreadCount.html +6 -6
- package/docs/interfaces/UnregisterMessageListenerInput.html +8 -8
- package/docs/interfaces/UpdateChannelInput.html +20 -20
- package/docs/interfaces/UpdateChannelMemberRoleInput.html +10 -10
- package/docs/interfaces/UpdateGroupInput.html +12 -12
- package/docs/interfaces/UpdateGroupMemberRoleInput.html +10 -10
- package/docs/interfaces/UpdateHandleInput.html +6 -6
- package/docs/interfaces/Video.html +19 -19
- package/docs/interfaces/VideoMedia.html +11 -11
- package/docs/interfaces/WithdrawChannelInvitationInput.html +8 -8
- package/docs/interfaces/WithdrawGroupInvitationInput.html +8 -8
- package/docs/interfaces/WithdrawInvitationRequestInput.html +6 -6
- package/docs/modules.html +1 -1
- package/docs/types/MediaInfo.html +2 -2
- package/docs/types/MessageContent.html +2 -2
- package/docs/types/MessageMention.html +2 -2
- package/docs/types/RedactReason.html +2 -2
- package/docs/types/SecureCommsClientOptions.html +9 -5
- package/lib/private/data/common/apiClient.js +21 -35
- package/lib/private/data/common/apiClient.js.map +1 -1
- package/lib/private/data/common/transformer/errorTransformer.js +6 -4
- package/lib/private/data/common/transformer/errorTransformer.js.map +1 -1
- package/lib/private/data/messaging/matrixMessagingService.js +6 -1
- package/lib/private/data/messaging/matrixMessagingService.js.map +1 -1
- package/lib/private/data/session/sessionManager.js +2 -2
- package/lib/private/data/session/sessionManager.js.map +1 -1
- package/lib/public/errors.js +6 -1
- package/lib/public/errors.js.map +1 -1
- package/package.json +32 -36
- package/types/private/data/common/apiClient.d.ts +1 -0
- package/types/private/data/common/transformer/errorTransformer.d.ts +6 -2
- package/types/public/errors.d.ts +4 -1
- package/docs/classes/InvalidHandleError.html +0 -33
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecurityModule | @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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-secure-communications</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" 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></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">SecurityModule</a></li></ul><h1>Interface SecurityModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Key backup, restore and interactive device verification services.</p>
|
|
2
2
|
<p>In the secure communications offering, each device stores their own keys.
|
|
3
3
|
To seamlessly continue conversations across multiple devices,
|
|
4
4
|
the keys must be replicated across those devices.
|
|
@@ -19,62 +19,62 @@ the same handle of two different devices, the unverified device becomes verified
|
|
|
19
19
|
and will then gain access to session keys from their other devices.</p>
|
|
20
20
|
</li>
|
|
21
21
|
</ol>
|
|
22
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SecurityModule</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#acceptverificationrequest-1">acceptVerificationRequest</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="AcceptVerificationRequestInput.html" class="tsd-signature-type tsd-kind-interface">AcceptVerificationRequestInput</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#approveverification-1">approveVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#cancelverification-1">cancelVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#createbackup-1">createBackup</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#declineverification-1">declineVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#getbackupstate-1">getBackupState</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><a href="../enums/BackupState.html" class="tsd-signature-type tsd-kind-enum">BackupState</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#isverified-1">isVerified</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#onsessionverificationchanged-1">onSessionVerificationChanged</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#onverificationrequestreceived-1">onVerificationRequestReceived</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#recover-1">recover</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#requestverification-1">requestVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#resetbackupkey-1">resetBackupKey</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#rotatebackupkey-1">rotateBackupKey</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="SecurityModule.html#startverification-1">startVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/DefaultSecurityModule.html" class="tsd-signature-type tsd-kind-class">DefaultSecurityModule</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:209</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">Methods</h3><div class="tsd-index-list"><a href="SecurityModule.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>
|
|
23
|
-
<a href="
|
|
24
|
-
<a href="
|
|
25
|
-
<a href="
|
|
26
|
-
<a href="
|
|
27
|
-
<a href="
|
|
28
|
-
<a href="
|
|
29
|
-
<a href="
|
|
30
|
-
<a href="
|
|
31
|
-
<a href="
|
|
32
|
-
<a href="
|
|
33
|
-
<a href="
|
|
34
|
-
<a href="
|
|
35
|
-
<a href="
|
|
36
|
-
</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-Methods"><
|
|
22
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SecurityModule</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#acceptverificationrequest-1">acceptVerificationRequest</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="AcceptVerificationRequestInput.html" class="tsd-signature-type tsd-kind-interface">AcceptVerificationRequestInput</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#approveverification-1">approveVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#cancelverification-1">cancelVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#createbackup-1">createBackup</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#declineverification-1">declineVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getbackupstate-1">getBackupState</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><a href="../enums/BackupState.html" class="tsd-signature-type tsd-kind-enum">BackupState</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#isverified-1">isVerified</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#onsessionverificationchanged-1">onSessionVerificationChanged</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#onverificationrequestreceived-1">onVerificationRequestReceived</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#recover-1">recover</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#requestverification-1">requestVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#resetbackupkey-1">resetBackupKey</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#rotatebackupkey-1">rotateBackupKey</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#startverification-1">startVerification</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/DefaultSecurityModule.html" class="tsd-signature-type tsd-kind-class">DefaultSecurityModule</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:209</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#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>
|
|
23
|
+
<a href="#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>
|
|
24
|
+
<a href="#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>
|
|
25
|
+
<a href="#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>
|
|
26
|
+
<a href="#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>
|
|
27
|
+
<a href="#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>
|
|
28
|
+
<a href="#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>
|
|
29
|
+
<a href="#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>
|
|
30
|
+
<a href="#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>
|
|
31
|
+
<a href="#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>
|
|
32
|
+
<a href="#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>
|
|
33
|
+
<a href="#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>
|
|
34
|
+
<a href="#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>
|
|
35
|
+
<a href="#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>
|
|
36
|
+
</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-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><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="acceptverificationrequest"><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" id="acceptverificationrequest-1"><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="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>
|
|
37
37
|
</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="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>
|
|
38
|
-
</div
|
|
38
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:296</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="approveverification"><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" id="approveverification-1"><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="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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]
|
|
39
39
|
to ensure the emojis match before approving.</p>
|
|
40
40
|
</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="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>
|
|
41
|
-
</div
|
|
41
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:321</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cancelverification"><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" id="cancelverification-1"><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="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>
|
|
42
42
|
</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="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>
|
|
43
|
-
</div
|
|
43
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:313</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createbackup"><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" id="createbackup-1"><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="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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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.
|
|
44
44
|
After creation, keys are automatically uploaded to the backup so this
|
|
45
45
|
only has to be called once.</p>
|
|
46
46
|
</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="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>
|
|
47
|
-
</div
|
|
48
|
-
<
|
|
47
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>a backup key, to be used with the [recover] method to recover keys from the server backup.</p>
|
|
48
|
+
<aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:243</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="declineverification"><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" id="declineverification-1"><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="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>
|
|
49
49
|
</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="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>
|
|
50
|
-
</div
|
|
50
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:328</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getbackupstate"><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" id="getbackupstate-1"><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="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"><</span><a href="../enums/BackupState.html" class="tsd-signature-type tsd-kind-enum">BackupState</a><span class="tsd-signature-symbol">></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>
|
|
51
51
|
</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="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>
|
|
52
|
-
</div
|
|
53
|
-
<
|
|
52
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../enums/BackupState.html" class="tsd-signature-type tsd-kind-enum">BackupState</a><span class="tsd-signature-symbol">></span></h4><p>the current backup state</p>
|
|
53
|
+
<aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:233</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isverified"><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" id="isverified-1"><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="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"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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>
|
|
54
54
|
</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="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>
|
|
55
|
-
</div
|
|
56
|
-
<
|
|
55
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>true if the current session is verified, false otherwise</p>
|
|
56
|
+
<aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:216</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onsessionverificationchanged"><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" id="onsessionverificationchanged-1"><span class="tsd-kind-call-signature">onSessionVerificationChanged</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="OnSessionVerificationChangedInput.html" class="tsd-signature-type tsd-kind-interface">OnSessionVerificationChangedInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</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>
|
|
57
57
|
</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="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>
|
|
58
|
-
</div
|
|
58
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:223</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onverificationrequestreceived"><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" id="onverificationrequestreceived-1"><span class="tsd-kind-call-signature">onVerificationRequestReceived</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="OnVerificationRequestReceivedInput.html" class="tsd-signature-type tsd-kind-interface">OnVerificationRequestReceivedInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</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>
|
|
59
59
|
</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="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>
|
|
60
|
-
</div
|
|
60
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:281</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="recover"><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" id="recover-1"><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="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>
|
|
61
61
|
</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="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>
|
|
62
|
-
</div
|
|
62
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:250</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="requestverification"><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" id="requestverification-1"><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="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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
|
|
63
63
|
another verified, online device.</p>
|
|
64
64
|
</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="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>
|
|
65
|
-
</div
|
|
65
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:289</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="resetbackupkey"><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" id="resetbackupkey-1"><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="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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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
|
|
66
66
|
this device. This will result in data loss of previous messages encrypted with keys
|
|
67
67
|
from the previous backup not known to this device. All other devices associated
|
|
68
68
|
with this user will become unverified.</p>
|
|
69
69
|
</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="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>
|
|
70
|
-
</div
|
|
70
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>a new backup key, to be used with the [recover] method to recover
|
|
71
71
|
keys from the server backup.</p>
|
|
72
|
-
<
|
|
72
|
+
<aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:272</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rotatebackupkey"><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" id="rotatebackupkey-1"><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="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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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.
|
|
73
73
|
Only verified sessions can execute this command.</p>
|
|
74
74
|
</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="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>
|
|
75
|
-
</div
|
|
75
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>a new backup key, to be used with the [recover] method to recover
|
|
76
76
|
keys from the server backup.</p>
|
|
77
|
-
<
|
|
77
|
+
<aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:260</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startverification"><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" id="startverification-1"><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="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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
|
|
78
78
|
has accepted the verification request. Either device can start the verification.</p>
|
|
79
79
|
</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="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>
|
|
80
|
-
</div
|
|
80
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/securityModule.ts:306</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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>
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SelfDestructInfo | @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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-secure-communications</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" 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></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">SelfDestructInfo</a></li></ul><h1>Interface SelfDestructInfo</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Self-destruct information for a message.</p>
|
|
2
2
|
<p>SelfDestructInfo</p>
|
|
3
|
-
</div
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
6
|
-
</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-Properties"><
|
|
3
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SelfDestructInfo</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#clientduration">clientDuration</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clientexpiry">clientExpiry</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#serverexpiry">serverExpiry</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:290</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#clientduration" 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>client<wbr/>Duration?</span></a>
|
|
4
|
+
<a href="#clientexpiry" 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>client<wbr/>Expiry?</span></a>
|
|
5
|
+
<a href="#serverexpiry" 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>server<wbr/>Expiry?</span></a>
|
|
6
|
+
</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-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><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clientduration"><code class="tsd-tag">Optional</code><span>client<wbr/>Duration</span><a href="#clientduration" 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">clientDuration</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The length of time this message should be available.
|
|
7
7
|
If undefined, the message should be available indefinitely.</p>
|
|
8
|
-
</div><
|
|
9
|
-
</div><
|
|
8
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:291</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clientexpiry"><code class="tsd-tag">Optional</code><span>client<wbr/>Expiry</span><a href="#clientexpiry" 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">clientExpiry</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The client-side expiry time of this message.</p>
|
|
9
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:292</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="serverexpiry"><code class="tsd-tag">Optional</code><span>server<wbr/>Expiry</span><a href="#serverexpiry" 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">serverExpiry</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The expiry time of this message on the server. After this time, the
|
|
10
10
|
server removes the contents of the message.</p>
|
|
11
|
-
</div><
|
|
11
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:293</li></ul></aside></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-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="#clientduration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Duration</span></a><a href="#clientexpiry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Expiry</span></a><a href="#serverexpiry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Expiry</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>
|