@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.
Files changed (261) hide show
  1. package/cjs/private/data/common/apiClient.js +20 -34
  2. package/cjs/private/data/common/apiClient.js.map +1 -1
  3. package/cjs/private/data/common/transformer/errorTransformer.js +5 -3
  4. package/cjs/private/data/common/transformer/errorTransformer.js.map +1 -1
  5. package/cjs/private/data/messaging/matrixMessagingService.js +6 -1
  6. package/cjs/private/data/messaging/matrixMessagingService.js.map +1 -1
  7. package/cjs/private/data/session/sessionManager.js +2 -2
  8. package/cjs/private/data/session/sessionManager.js.map +1 -1
  9. package/cjs/public/errors.js +9 -3
  10. package/cjs/public/errors.js.map +1 -1
  11. package/docs/assets/hierarchy.js +1 -1
  12. package/docs/assets/main.js +5 -5
  13. package/docs/assets/navigation.js +1 -1
  14. package/docs/assets/search.js +1 -1
  15. package/docs/assets/style.css +248 -226
  16. package/docs/classes/AliasNotAvailableError.html +12 -12
  17. package/docs/classes/ChannelId.html +7 -7
  18. package/docs/classes/ChannelNameNotAvailableError.html +12 -12
  19. package/docs/classes/ChannelNotFoundError.html +12 -12
  20. package/docs/classes/ChannelPermissions.html +21 -21
  21. package/docs/classes/ChatId.html +7 -7
  22. package/docs/classes/DefaultChannelsModule.html +66 -66
  23. package/docs/classes/DefaultDirectChatsModule.html +23 -23
  24. package/docs/classes/DefaultGroupsModule.html +44 -44
  25. package/docs/classes/DefaultHandlesModule.html +13 -13
  26. package/docs/classes/DefaultMediaModule.html +6 -6
  27. package/docs/classes/DefaultMessagingModule.html +51 -51
  28. package/docs/classes/DefaultNotificationsModule.html +17 -17
  29. package/docs/classes/DefaultSecureCommsClient.html +28 -28
  30. package/docs/classes/DefaultSecurityModule.html +36 -36
  31. package/docs/classes/DefaultStorageModule.html +11 -11
  32. package/docs/classes/DirectChatExistsError.html +12 -12
  33. package/docs/classes/DirectChatMembershipError.html +12 -12
  34. package/docs/classes/DirectChatPermissions.html +7 -7
  35. package/docs/classes/GroupId.html +7 -7
  36. package/docs/classes/GroupPermissions.html +21 -21
  37. package/docs/classes/HandleId.html +5 -5
  38. package/docs/classes/HandleNotAvailableError.html +12 -12
  39. package/docs/classes/HandleNotFoundError.html +12 -12
  40. package/docs/classes/IndexedDBStorageProviderFactory.html +3 -3
  41. package/docs/classes/InternalError.html +12 -12
  42. package/docs/classes/InvalidArgumentError.html +12 -12
  43. package/docs/classes/InvalidChannelAliasError.html +12 -12
  44. package/docs/classes/InvalidChannelStateError.html +12 -12
  45. package/docs/classes/InvalidHandleIdError.html +33 -0
  46. package/docs/classes/InvalidHandleNameError.html +33 -0
  47. package/docs/classes/NotAllowedError.html +12 -12
  48. package/docs/classes/PermissionDeniedError.html +12 -12
  49. package/docs/classes/RoomNotFoundError.html +12 -12
  50. package/docs/classes/S3DownloadError.html +13 -13
  51. package/docs/classes/S3UploadError.html +13 -13
  52. package/docs/classes/SecureCommsError.html +12 -12
  53. package/docs/classes/SecureCommsServiceConfigNotFoundError.html +12 -12
  54. package/docs/classes/UnacceptableWordsError.html +12 -12
  55. package/docs/classes/UnauthorizedError.html +12 -12
  56. package/docs/enums/BackupState.html +6 -6
  57. package/docs/enums/ChannelJoinRule.html +5 -5
  58. package/docs/enums/ChannelRole.html +6 -6
  59. package/docs/enums/ChannelSortDirection.html +4 -4
  60. package/docs/enums/ChannelSortField.html +4 -4
  61. package/docs/enums/DirectChatRole.html +4 -4
  62. package/docs/enums/GroupRole.html +5 -5
  63. package/docs/enums/MembershipState.html +7 -7
  64. package/docs/enums/MessageNotificationLevel.html +4 -4
  65. package/docs/enums/MessageState.html +5 -5
  66. package/docs/enums/NotificationInfoType.html +3 -3
  67. package/docs/enums/PollType.html +4 -4
  68. package/docs/enums/PublicChannelJoinRule.html +4 -4
  69. package/docs/hierarchy.html +1 -1
  70. package/docs/index.html +5 -5
  71. package/docs/interfaces/AcceptChannelInvitationInput.html +6 -6
  72. package/docs/interfaces/AcceptGroupInvitationInput.html +6 -6
  73. package/docs/interfaces/AcceptInvitationInput.html +6 -6
  74. package/docs/interfaces/AcceptInvitationRequestInput.html +8 -8
  75. package/docs/interfaces/AcceptVerificationRequestInput.html +8 -8
  76. package/docs/interfaces/ApproveVerificationInput.html +4 -4
  77. package/docs/interfaces/Audio.html +13 -13
  78. package/docs/interfaces/AudioMedia.html +7 -7
  79. package/docs/interfaces/AvatarInput.html +8 -8
  80. package/docs/interfaces/BanChannelHandleInput.html +9 -9
  81. package/docs/interfaces/BanGroupHandleInput.html +10 -10
  82. package/docs/interfaces/BaseMessageContent.html +10 -10
  83. package/docs/interfaces/BlockHandleInput.html +6 -6
  84. package/docs/interfaces/CancelVerificationInput.html +4 -4
  85. package/docs/interfaces/Channel.html +24 -24
  86. package/docs/interfaces/ChannelInvitationRequest.html +10 -10
  87. package/docs/interfaces/ChannelInvite.html +5 -5
  88. package/docs/interfaces/ChannelMember.html +8 -8
  89. package/docs/interfaces/ChannelPermissionsInput.html +10 -10
  90. package/docs/interfaces/ChannelSortOrder.html +6 -6
  91. package/docs/interfaces/ChannelsModule.html +65 -65
  92. package/docs/interfaces/ChatMention.html +4 -4
  93. package/docs/interfaces/ChatNotificationRules.html +2 -2
  94. package/docs/interfaces/ChatSummary.html +12 -12
  95. package/docs/interfaces/ClearRecipientChatRulesInput.html +6 -6
  96. package/docs/interfaces/CreateBackupInput.html +4 -4
  97. package/docs/interfaces/CreateChannelInput.html +20 -20
  98. package/docs/interfaces/CreateChatInput.html +6 -6
  99. package/docs/interfaces/CreateGroupInput.html +12 -12
  100. package/docs/interfaces/CreatePollInput.html +14 -14
  101. package/docs/interfaces/DeclineChannelInvitationInput.html +6 -6
  102. package/docs/interfaces/DeclineGroupInvitationInput.html +6 -6
  103. package/docs/interfaces/DeclineInvitationInput.html +6 -6
  104. package/docs/interfaces/DeclineInvitationRequestInput.html +10 -10
  105. package/docs/interfaces/DeclineVerificationInput.html +4 -4
  106. package/docs/interfaces/DeleteChannelInput.html +5 -5
  107. package/docs/interfaces/DeleteGroupInput.html +6 -6
  108. package/docs/interfaces/DeleteMessageInput.html +10 -10
  109. package/docs/interfaces/DeleteOwnRedactReason.html +6 -6
  110. package/docs/interfaces/DirectChat.html +6 -6
  111. package/docs/interfaces/DirectChatInvitation.html +6 -6
  112. package/docs/interfaces/DirectChatInvite.html +5 -5
  113. package/docs/interfaces/DirectChatsModule.html +22 -22
  114. package/docs/interfaces/DownloadMediaFileInput.html +10 -10
  115. package/docs/interfaces/EditMessageInput.html +10 -10
  116. package/docs/interfaces/EditPollInput.html +16 -16
  117. package/docs/interfaces/EditReactionRedactReason.html +4 -4
  118. package/docs/interfaces/Emote.html +9 -9
  119. package/docs/interfaces/EncryptedMessage.html +7 -7
  120. package/docs/interfaces/EndPollInput.html +8 -8
  121. package/docs/interfaces/EventListenerContent.html +8 -8
  122. package/docs/interfaces/EventListenerReaction.html +10 -10
  123. package/docs/interfaces/EventNotificationRules.html +2 -2
  124. package/docs/interfaces/File.html +13 -13
  125. package/docs/interfaces/FileEncryptionInfo.html +10 -10
  126. package/docs/interfaces/FileMedia.html +5 -5
  127. package/docs/interfaces/GetBackupStateInput.html +4 -4
  128. package/docs/interfaces/GetChannelInput.html +6 -6
  129. package/docs/interfaces/GetChannelMembersInput.html +6 -6
  130. package/docs/interfaces/GetChannelMembershipInput.html +6 -6
  131. package/docs/interfaces/GetChannelsInput.html +6 -6
  132. package/docs/interfaces/GetChatSummariesInput.html +6 -6
  133. package/docs/interfaces/GetDecodedInfoInput.html +8 -8
  134. package/docs/interfaces/GetGroupInput.html +6 -6
  135. package/docs/interfaces/GetGroupMembersInput.html +6 -6
  136. package/docs/interfaces/GetGroupsInput.html +6 -6
  137. package/docs/interfaces/GetMessageInput.html +8 -8
  138. package/docs/interfaces/GetMessagesInput.html +10 -10
  139. package/docs/interfaces/GetPinnedMessagesInput.html +6 -6
  140. package/docs/interfaces/GetPollResponsesInput.html +8 -8
  141. package/docs/interfaces/GetSettingsInput.html +4 -4
  142. package/docs/interfaces/Group.html +14 -14
  143. package/docs/interfaces/GroupInvite.html +5 -5
  144. package/docs/interfaces/GroupMember.html +8 -8
  145. package/docs/interfaces/GroupsModule.html +43 -43
  146. package/docs/interfaces/Handle.html +6 -6
  147. package/docs/interfaces/HandleMention.html +8 -8
  148. package/docs/interfaces/HandleStorage.html +6 -6
  149. package/docs/interfaces/HandlesModule.html +12 -12
  150. package/docs/interfaces/HashAlgorithmMap.html +4 -4
  151. package/docs/interfaces/Image.html +19 -19
  152. package/docs/interfaces/ImageMedia.html +9 -9
  153. package/docs/interfaces/Input.html +3 -3
  154. package/docs/interfaces/Invite.html +4 -4
  155. package/docs/interfaces/IsVerifiedInput.html +4 -4
  156. package/docs/interfaces/JoinChannelInput.html +6 -6
  157. package/docs/interfaces/KeyVerificationRequest.html +18 -18
  158. package/docs/interfaces/KickChannelHandleInput.html +10 -10
  159. package/docs/interfaces/KickGroupHandleInput.html +10 -10
  160. package/docs/interfaces/LeaveChannelInput.html +6 -6
  161. package/docs/interfaces/LeaveGroupInput.html +6 -6
  162. package/docs/interfaces/ListHandlesInput.html +6 -6
  163. package/docs/interfaces/ListReceivedInvitationRequestsInput.html +6 -6
  164. package/docs/interfaces/Location.html +11 -11
  165. package/docs/interfaces/MarkAsReadInput.html +6 -6
  166. package/docs/interfaces/MediaModule.html +5 -5
  167. package/docs/interfaces/Member.html +6 -6
  168. package/docs/interfaces/MembershipChange.html +14 -14
  169. package/docs/interfaces/Message.html +20 -20
  170. package/docs/interfaces/MessageNotification.html +5 -5
  171. package/docs/interfaces/MessageReaction.html +8 -8
  172. package/docs/interfaces/MessageReceipt.html +6 -6
  173. package/docs/interfaces/MessagingModule.html +50 -50
  174. package/docs/interfaces/ModerationRedactReason.html +10 -10
  175. package/docs/interfaces/Notice.html +9 -9
  176. package/docs/interfaces/NotificationInfo.html +4 -4
  177. package/docs/interfaces/NotificationSettings.html +4 -4
  178. package/docs/interfaces/NotificationsModule.html +16 -16
  179. package/docs/interfaces/OnSessionVerificationChangedInput.html +6 -6
  180. package/docs/interfaces/OnVerificationRequestReceivedInput.html +6 -6
  181. package/docs/interfaces/OwnedHandle.html +10 -10
  182. package/docs/interfaces/Pagination.html +6 -6
  183. package/docs/interfaces/PinMessageInput.html +8 -8
  184. package/docs/interfaces/PlatformNotificationDataTemplate.html +6 -6
  185. package/docs/interfaces/Poll.html +15 -15
  186. package/docs/interfaces/PollResponse.html +11 -11
  187. package/docs/interfaces/PollResponses.html +8 -8
  188. package/docs/interfaces/ProvisionHandleInput.html +8 -8
  189. package/docs/interfaces/PublicChannelSearchInput.html +18 -18
  190. package/docs/interfaces/PublicChannelSearchResult.html +20 -20
  191. package/docs/interfaces/Recipient.html +4 -4
  192. package/docs/interfaces/RecoverInput.html +6 -6
  193. package/docs/interfaces/RedactedMessage.html +12 -12
  194. package/docs/interfaces/RegisterMessageListenerInput.html +10 -10
  195. package/docs/interfaces/RequestVerificationInput.html +4 -4
  196. package/docs/interfaces/ResetBackupKeyInput.html +4 -4
  197. package/docs/interfaces/RotateBackupKeyInput.html +4 -4
  198. package/docs/interfaces/SearchMessagesInput.html +10 -10
  199. package/docs/interfaces/SearchMessagesItem.html +18 -18
  200. package/docs/interfaces/SecureCommsClient.html +28 -28
  201. package/docs/interfaces/SecureCommsSession.html +18 -18
  202. package/docs/interfaces/SecureCommsStore.html +8 -8
  203. package/docs/interfaces/SecurityModule.html +35 -35
  204. package/docs/interfaces/SelfDestructInfo.html +8 -8
  205. package/docs/interfaces/SelfDestructedMessage.html +10 -10
  206. package/docs/interfaces/SendChannelInvitationsInput.html +8 -8
  207. package/docs/interfaces/SendGroupInvitationsInput.html +8 -8
  208. package/docs/interfaces/SendInvitationRequestInput.html +8 -8
  209. package/docs/interfaces/SendMediaInput.html +26 -26
  210. package/docs/interfaces/SendMessageInput.html +18 -18
  211. package/docs/interfaces/SendPollResponseInput.html +10 -10
  212. package/docs/interfaces/SendTypingNotificationInput.html +8 -8
  213. package/docs/interfaces/SessionAPIs.html +5 -5
  214. package/docs/interfaces/SetDefaultChatRulesInput.html +6 -6
  215. package/docs/interfaces/SetDefaultEventRulesInput.html +6 -6
  216. package/docs/interfaces/SetRecipientChatRulesInput.html +8 -8
  217. package/docs/interfaces/StartVerificationInput.html +4 -4
  218. package/docs/interfaces/StorageModule.html +10 -10
  219. package/docs/interfaces/StorageProvider.html +32 -32
  220. package/docs/interfaces/StorageProviderFactory.html +2 -2
  221. package/docs/interfaces/Text.html +9 -9
  222. package/docs/interfaces/ThumbnailInfo.html +12 -12
  223. package/docs/interfaces/ToggleReactionInput.html +10 -10
  224. package/docs/interfaces/UnbanChannelHandleInput.html +9 -9
  225. package/docs/interfaces/UnbanGroupHandleInput.html +10 -10
  226. package/docs/interfaces/UnblockHandleInput.html +6 -6
  227. package/docs/interfaces/UnknownRedactReason.html +4 -4
  228. package/docs/interfaces/UnpinMessageInput.html +8 -8
  229. package/docs/interfaces/UnreadCount.html +6 -6
  230. package/docs/interfaces/UnregisterMessageListenerInput.html +8 -8
  231. package/docs/interfaces/UpdateChannelInput.html +20 -20
  232. package/docs/interfaces/UpdateChannelMemberRoleInput.html +10 -10
  233. package/docs/interfaces/UpdateGroupInput.html +12 -12
  234. package/docs/interfaces/UpdateGroupMemberRoleInput.html +10 -10
  235. package/docs/interfaces/UpdateHandleInput.html +6 -6
  236. package/docs/interfaces/Video.html +19 -19
  237. package/docs/interfaces/VideoMedia.html +11 -11
  238. package/docs/interfaces/WithdrawChannelInvitationInput.html +8 -8
  239. package/docs/interfaces/WithdrawGroupInvitationInput.html +8 -8
  240. package/docs/interfaces/WithdrawInvitationRequestInput.html +6 -6
  241. package/docs/modules.html +1 -1
  242. package/docs/types/MediaInfo.html +2 -2
  243. package/docs/types/MessageContent.html +2 -2
  244. package/docs/types/MessageMention.html +2 -2
  245. package/docs/types/RedactReason.html +2 -2
  246. package/docs/types/SecureCommsClientOptions.html +9 -5
  247. package/lib/private/data/common/apiClient.js +21 -35
  248. package/lib/private/data/common/apiClient.js.map +1 -1
  249. package/lib/private/data/common/transformer/errorTransformer.js +6 -4
  250. package/lib/private/data/common/transformer/errorTransformer.js.map +1 -1
  251. package/lib/private/data/messaging/matrixMessagingService.js +6 -1
  252. package/lib/private/data/messaging/matrixMessagingService.js.map +1 -1
  253. package/lib/private/data/session/sessionManager.js +2 -2
  254. package/lib/private/data/session/sessionManager.js.map +1 -1
  255. package/lib/public/errors.js +6 -1
  256. package/lib/public/errors.js.map +1 -1
  257. package/package.json +32 -36
  258. package/types/private/data/common/apiClient.d.ts +1 -0
  259. package/types/private/data/common/transformer/errorTransformer.d.ts +6 -2
  260. package/types/public/errors.d.ts +4 -1
  261. package/docs/classes/InvalidHandleError.html +0 -33
@@ -1,23 +1,23 @@
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>DefaultNotificationsModule | @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="DefaultNotificationsModule.html">DefaultNotificationsModule</a></li></ul><h1>Class DefaultNotificationsModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Notification related methods for the Secure Communications Service.</p>
2
- </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/NotificationsModule.html" class="tsd-signature-type tsd-kind-interface">NotificationsModule</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/notificationsModule.ts:152</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="DefaultNotificationsModule.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>
3
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="DefaultNotificationsModule.html#clearrecipientchatrules" 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>clear<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span></a>
4
- <a href="DefaultNotificationsModule.html#getdecodedinfo" 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/>Decoded<wbr/>Info</span></a>
5
- <a href="DefaultNotificationsModule.html#getsettings" 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/>Settings</span></a>
6
- <a href="DefaultNotificationsModule.html#setdefaultchatrules" 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>set<wbr/>Default<wbr/>Chat<wbr/>Rules</span></a>
7
- <a href="DefaultNotificationsModule.html#setdefaulteventrules" 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>set<wbr/>Default<wbr/>Event<wbr/>Rules</span></a>
8
- <a href="DefaultNotificationsModule.html#setrecipientchatrules" 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>set<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span></a>
9
- </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="constructordefaultnotificationsmodule" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultNotificationsModule</span><span class="tsd-signature-symbol">(</span><br/>    <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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="DefaultNotificationsModule.html" class="tsd-signature-type tsd-kind-class">DefaultNotificationsModule</a><a href="#constructordefaultnotificationsmodule" 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="DefaultNotificationsModule.html" class="tsd-signature-type tsd-kind-class">DefaultNotificationsModule</a></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/notificationsModule.ts:155</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="clearrecipientchatrules" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span><a href="#clearrecipientchatrules" 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="clearrecipientchatrules-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clearRecipientChatRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ClearRecipientChatRulesInput.html" class="tsd-signature-type tsd-kind-interface">ClearRecipientChatRulesInput</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="#clearrecipientchatrules-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>Clear the notification rule for a specific recipient.</p>
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>DefaultNotificationsModule | @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">DefaultNotificationsModule</a></li></ul><h1>Class DefaultNotificationsModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Notification related methods for the Secure Communications Service.</p>
2
+ </div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/NotificationsModule.html" class="tsd-signature-type tsd-kind-interface">NotificationsModule</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/notificationsModule.ts:152</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">Constructors</h3><div class="tsd-index-list"><a href="#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>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#clearrecipientchatrules" 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>clear<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span></a>
4
+ <a href="#getdecodedinfo" 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/>Decoded<wbr/>Info</span></a>
5
+ <a href="#getsettings" 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/>Settings</span></a>
6
+ <a href="#setdefaultchatrules" 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>set<wbr/>Default<wbr/>Chat<wbr/>Rules</span></a>
7
+ <a href="#setdefaulteventrules" 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>set<wbr/>Default<wbr/>Event<wbr/>Rules</span></a>
8
+ <a href="#setrecipientchatrules" 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>set<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span></a>
9
+ </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"><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>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><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" id="constructordefaultnotificationsmodule"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultNotificationsModule</span><span class="tsd-signature-symbol">(</span><br/>    <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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultNotificationsModule</a><a href="#constructordefaultnotificationsmodule" 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="" class="tsd-signature-type tsd-kind-class">DefaultNotificationsModule</a></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/notificationsModule.ts:155</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"><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="clearrecipientchatrules"><span>clear<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span><a href="#clearrecipientchatrules" 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="clearrecipientchatrules-1"><span class="tsd-kind-call-signature">clearRecipientChatRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ClearRecipientChatRulesInput.html" class="tsd-signature-type tsd-kind-interface">ClearRecipientChatRulesInput</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="#clearrecipientchatrules-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>Clear the notification rule for a specific recipient.</p>
10
10
  </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/ClearRecipientChatRulesInput.html" class="tsd-signature-type tsd-kind-interface">ClearRecipientChatRulesInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to clear the override chat notification rules.</p>
11
- </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/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#clearrecipientchatrules">clearRecipientChatRules</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:217</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getdecodedinfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Decoded<wbr/>Info</span><a href="#getdecodedinfo" 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="getdecodedinfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getDecodedInfo</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GetDecodedInfoInput.html" class="tsd-signature-type tsd-kind-interface">GetDecodedInfoInput</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">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/NotificationInfo.html" class="tsd-signature-type tsd-kind-interface">NotificationInfo</a><span class="tsd-signature-symbol">&gt;</span><a href="#getdecodedinfo-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>Decode a remote notification content into a <a href="../interfaces/NotificationInfo.html" class="tsd-kind-interface">NotificationInfo</a>.</p>
11
+ </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><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#clearrecipientchatrules">clearRecipientChatRules</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:217</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdecodedinfo"><span>get<wbr/>Decoded<wbr/>Info</span><a href="#getdecodedinfo" 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="getdecodedinfo-1"><span class="tsd-kind-call-signature">getDecodedInfo</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GetDecodedInfoInput.html" class="tsd-signature-type tsd-kind-interface">GetDecodedInfoInput</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><a href="../interfaces/NotificationInfo.html" class="tsd-signature-type tsd-kind-interface">NotificationInfo</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getdecodedinfo-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>Decode a remote notification content into a <a href="../interfaces/NotificationInfo.html" class="tsd-kind-interface">NotificationInfo</a>.</p>
12
12
  </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/GetDecodedInfoInput.html" class="tsd-signature-type tsd-kind-interface">GetDecodedInfoInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to decode a notification content.</p>
13
- </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/NotificationInfo.html" class="tsd-signature-type tsd-kind-interface">NotificationInfo</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The decoded notification info, or undefined if the notification content is not a valid notification.</p>
14
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#getdecodedinfo">getDecodedInfo</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:159</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getsettings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Settings</span><a href="#getsettings" 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="getsettings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSettings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GetSettingsInput.html" class="tsd-signature-type tsd-kind-interface">GetSettingsInput</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="../interfaces/NotificationSettings.html" class="tsd-signature-type tsd-kind-interface">NotificationSettings</a><span class="tsd-signature-symbol">&gt;</span><a href="#getsettings-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 all notification settings.</p>
13
+ </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="../interfaces/NotificationInfo.html" class="tsd-signature-type tsd-kind-interface">NotificationInfo</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The decoded notification info, or undefined if the notification content is not a valid notification.</p>
14
+ <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#getdecodedinfo">getDecodedInfo</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:159</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getsettings"><span>get<wbr/>Settings</span><a href="#getsettings" 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="getsettings-1"><span class="tsd-kind-call-signature">getSettings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GetSettingsInput.html" class="tsd-signature-type tsd-kind-interface">GetSettingsInput</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="../interfaces/NotificationSettings.html" class="tsd-signature-type tsd-kind-interface">NotificationSettings</a><span class="tsd-signature-symbol">&gt;</span><a href="#getsettings-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 all notification settings.</p>
15
15
  </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/GetSettingsInput.html" class="tsd-signature-type tsd-kind-interface">GetSettingsInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to get the notification settings.</p>
16
- </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="../interfaces/NotificationSettings.html" class="tsd-signature-type tsd-kind-interface">NotificationSettings</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The notification settings for the given handle.</p>
17
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#getsettings">getSettings</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:171</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setdefaultchatrules" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Default<wbr/>Chat<wbr/>Rules</span><a href="#setdefaultchatrules" 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="setdefaultchatrules-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setDefaultChatRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SetDefaultChatRulesInput.html" class="tsd-signature-type tsd-kind-interface">SetDefaultChatRulesInput</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="#setdefaultchatrules-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>Set the default notification rules for all recipients (direct chats, groups, channels).</p>
16
+ </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="../interfaces/NotificationSettings.html" class="tsd-signature-type tsd-kind-interface">NotificationSettings</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The notification settings for the given handle.</p>
17
+ <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#getsettings">getSettings</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:171</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setdefaultchatrules"><span>set<wbr/>Default<wbr/>Chat<wbr/>Rules</span><a href="#setdefaultchatrules" 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="setdefaultchatrules-1"><span class="tsd-kind-call-signature">setDefaultChatRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SetDefaultChatRulesInput.html" class="tsd-signature-type tsd-kind-interface">SetDefaultChatRulesInput</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="#setdefaultchatrules-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>Set the default notification rules for all recipients (direct chats, groups, channels).</p>
18
18
  </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/SetDefaultChatRulesInput.html" class="tsd-signature-type tsd-kind-interface">SetDefaultChatRulesInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to set the default chat notification rules.</p>
19
- </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/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#setdefaultchatrules">setDefaultChatRules</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:193</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setdefaulteventrules" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Default<wbr/>Event<wbr/>Rules</span><a href="#setdefaulteventrules" 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="setdefaulteventrules-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setDefaultEventRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SetDefaultEventRulesInput.html" class="tsd-signature-type tsd-kind-interface">SetDefaultEventRulesInput</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="#setdefaulteventrules-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>Set the default notification rules for events (e.g. invitations).</p>
19
+ </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><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#setdefaultchatrules">setDefaultChatRules</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:193</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setdefaulteventrules"><span>set<wbr/>Default<wbr/>Event<wbr/>Rules</span><a href="#setdefaulteventrules" 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="setdefaulteventrules-1"><span class="tsd-kind-call-signature">setDefaultEventRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SetDefaultEventRulesInput.html" class="tsd-signature-type tsd-kind-interface">SetDefaultEventRulesInput</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="#setdefaulteventrules-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>Set the default notification rules for events (e.g. invitations).</p>
20
20
  </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/SetDefaultEventRulesInput.html" class="tsd-signature-type tsd-kind-interface">SetDefaultEventRulesInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to set the default event notification rules.</p>
21
- </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/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#setdefaulteventrules">setDefaultEventRules</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:181</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setrecipientchatrules" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span><a href="#setrecipientchatrules" 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="setrecipientchatrules-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setRecipientChatRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SetRecipientChatRulesInput.html" class="tsd-signature-type tsd-kind-interface">SetRecipientChatRulesInput</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="#setrecipientchatrules-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>Set the notification rule for a specific recipient (which will take precedence over the default chat rules).</p>
21
+ </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><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#setdefaulteventrules">setDefaultEventRules</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:181</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setrecipientchatrules"><span>set<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span><a href="#setrecipientchatrules" 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="setrecipientchatrules-1"><span class="tsd-kind-call-signature">setRecipientChatRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SetRecipientChatRulesInput.html" class="tsd-signature-type tsd-kind-interface">SetRecipientChatRulesInput</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="#setrecipientchatrules-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>Set the notification rule for a specific recipient (which will take precedence over the default chat rules).</p>
22
22
  </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/SetRecipientChatRulesInput.html" class="tsd-signature-type tsd-kind-interface">SetRecipientChatRulesInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to set the override chat notification rules.</p>
23
- </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/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#setrecipientchatrules">setRecipientChatRules</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:205</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="#clearrecipientchatrules" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span></a><a href="#getdecodedinfo" 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/>Decoded<wbr/>Info</span></a><a href="#getsettings" 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/>Settings</span></a><a href="#setdefaultchatrules" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Chat<wbr/>Rules</span></a><a href="#setdefaulteventrules" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Event<wbr/>Rules</span></a><a href="#setrecipientchatrules" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Recipient<wbr/>Chat<wbr/>Rules</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>
23
+ </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><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/NotificationsModule.html">NotificationsModule</a>.<a href="../interfaces/NotificationsModule.html#setrecipientchatrules">setRecipientChatRules</a></p><ul><li>Defined in src/public/modules/notificationsModule.ts:205</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-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"><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="#clearrecipientchatrules"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Recipient<wbr/>Chat<wbr/>Rules</span></a><a href="#getdecodedinfo"><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/>Decoded<wbr/>Info</span></a><a href="#getsettings"><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/>Settings</span></a><a href="#setdefaultchatrules"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Chat<wbr/>Rules</span></a><a href="#setdefaulteventrules"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Event<wbr/>Rules</span></a><a href="#setrecipientchatrules"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Recipient<wbr/>Chat<wbr/>Rules</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,30 +1,30 @@
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>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>
2
- </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>
3
- <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>
4
- <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>
5
- <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>
6
- <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>
7
- <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>
8
- <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>
9
- <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>
10
- <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>
11
- </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>
12
- <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>
13
- <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>
14
- <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>
15
- </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>
16
- </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>
17
- </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>
18
- </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>
19
- </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>
20
- </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>
21
- </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>
22
- </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>
23
- </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>
24
- </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>
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>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(() => 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">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"><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">Constructors</h3><div class="tsd-index-list"><a href="#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>
2
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#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>
3
+ <a href="#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>
4
+ <a href="#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>
5
+ <a href="#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>
6
+ <a href="#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>
7
+ <a href="#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>
8
+ <a href="#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>
9
+ <a href="#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>
10
+ <a href="#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>
11
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#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>
12
+ <a href="#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>
13
+ <a href="#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>
14
+ <a href="#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>
15
+ </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"><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>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><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" id="constructordefaultsecurecommsclient"><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="" 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="" 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"><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="channels"><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>
16
+ </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"><h3 class="tsd-anchor-link" id="directchats"><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>
17
+ </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"><h3 class="tsd-anchor-link" id="groups"><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>
18
+ </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"><h3 class="tsd-anchor-link" id="handles"><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>
19
+ </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"><h3 class="tsd-anchor-link" id="media"><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>
20
+ </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"><h3 class="tsd-anchor-link" id="messaging"><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>
21
+ </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"><h3 class="tsd-anchor-link" id="notifications"><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>
22
+ </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"><h3 class="tsd-anchor-link" id="security"><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>
23
+ </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"><h3 class="tsd-anchor-link" id="storage"><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>
24
+ </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"><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="isready"><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" id="isready-1"><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>
25
25
  </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>
26
- <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>
27
- </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>
26
+ <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"><h3 class="tsd-anchor-link" id="reset"><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" id="reset-1"><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>
27
+ </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><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"><h3 class="tsd-anchor-link" id="startsyncing"><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" id="startsyncing-1"><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>
28
28
  <p>Can only be called after sign-in creation of a handle.</p>
29
- </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>
30
- </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>
29
+ </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><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"><h3 class="tsd-anchor-link" id="stopsyncing"><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" id="stopsyncing-1"><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>
30
+ </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><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"><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-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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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>