@sudoplatform/sudo-secure-communications 5.1.2 → 5.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/private/data/common/apiClient.js +20 -34
- package/cjs/private/data/common/apiClient.js.map +1 -1
- package/cjs/private/data/common/transformer/errorTransformer.js +5 -3
- package/cjs/private/data/common/transformer/errorTransformer.js.map +1 -1
- package/cjs/private/data/session/sessionManager.js +2 -2
- package/cjs/private/data/session/sessionManager.js.map +1 -1
- package/cjs/public/errors.js +9 -3
- package/cjs/public/errors.js.map +1 -1
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/main.js +5 -5
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +248 -226
- package/docs/classes/AliasNotAvailableError.html +12 -12
- package/docs/classes/ChannelId.html +7 -7
- package/docs/classes/ChannelNameNotAvailableError.html +12 -12
- package/docs/classes/ChannelNotFoundError.html +12 -12
- package/docs/classes/ChannelPermissions.html +21 -21
- package/docs/classes/ChatId.html +7 -7
- package/docs/classes/DefaultChannelsModule.html +66 -66
- package/docs/classes/DefaultDirectChatsModule.html +23 -23
- package/docs/classes/DefaultGroupsModule.html +44 -44
- package/docs/classes/DefaultHandlesModule.html +13 -13
- package/docs/classes/DefaultMediaModule.html +6 -6
- package/docs/classes/DefaultMessagingModule.html +51 -51
- package/docs/classes/DefaultNotificationsModule.html +17 -17
- package/docs/classes/DefaultSecureCommsClient.html +28 -28
- package/docs/classes/DefaultSecurityModule.html +36 -36
- package/docs/classes/DefaultStorageModule.html +11 -11
- package/docs/classes/DirectChatExistsError.html +12 -12
- package/docs/classes/DirectChatMembershipError.html +12 -12
- package/docs/classes/DirectChatPermissions.html +7 -7
- package/docs/classes/GroupId.html +7 -7
- package/docs/classes/GroupPermissions.html +21 -21
- package/docs/classes/HandleId.html +5 -5
- package/docs/classes/HandleNotAvailableError.html +12 -12
- package/docs/classes/HandleNotFoundError.html +12 -12
- package/docs/classes/IndexedDBStorageProviderFactory.html +3 -3
- package/docs/classes/InternalError.html +12 -12
- package/docs/classes/InvalidArgumentError.html +12 -12
- package/docs/classes/InvalidChannelAliasError.html +12 -12
- package/docs/classes/InvalidChannelStateError.html +12 -12
- package/docs/classes/InvalidHandleIdError.html +33 -0
- package/docs/classes/InvalidHandleNameError.html +33 -0
- package/docs/classes/NotAllowedError.html +12 -12
- package/docs/classes/PermissionDeniedError.html +12 -12
- package/docs/classes/RoomNotFoundError.html +12 -12
- package/docs/classes/S3DownloadError.html +13 -13
- package/docs/classes/S3UploadError.html +13 -13
- package/docs/classes/SecureCommsError.html +12 -12
- package/docs/classes/SecureCommsServiceConfigNotFoundError.html +12 -12
- package/docs/classes/UnacceptableWordsError.html +12 -12
- package/docs/classes/UnauthorizedError.html +12 -12
- package/docs/enums/BackupState.html +6 -6
- package/docs/enums/ChannelJoinRule.html +5 -5
- package/docs/enums/ChannelRole.html +6 -6
- package/docs/enums/ChannelSortDirection.html +4 -4
- package/docs/enums/ChannelSortField.html +4 -4
- package/docs/enums/DirectChatRole.html +4 -4
- package/docs/enums/GroupRole.html +5 -5
- package/docs/enums/MembershipState.html +7 -7
- package/docs/enums/MessageNotificationLevel.html +4 -4
- package/docs/enums/MessageState.html +5 -5
- package/docs/enums/NotificationInfoType.html +3 -3
- package/docs/enums/PollType.html +4 -4
- package/docs/enums/PublicChannelJoinRule.html +4 -4
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +5 -5
- package/docs/interfaces/AcceptChannelInvitationInput.html +6 -6
- package/docs/interfaces/AcceptGroupInvitationInput.html +6 -6
- package/docs/interfaces/AcceptInvitationInput.html +6 -6
- package/docs/interfaces/AcceptInvitationRequestInput.html +8 -8
- package/docs/interfaces/AcceptVerificationRequestInput.html +8 -8
- package/docs/interfaces/ApproveVerificationInput.html +4 -4
- package/docs/interfaces/Audio.html +13 -13
- package/docs/interfaces/AudioMedia.html +7 -7
- package/docs/interfaces/AvatarInput.html +8 -8
- package/docs/interfaces/BanChannelHandleInput.html +9 -9
- package/docs/interfaces/BanGroupHandleInput.html +10 -10
- package/docs/interfaces/BaseMessageContent.html +10 -10
- package/docs/interfaces/BlockHandleInput.html +6 -6
- package/docs/interfaces/CancelVerificationInput.html +4 -4
- package/docs/interfaces/Channel.html +24 -24
- package/docs/interfaces/ChannelInvitationRequest.html +10 -10
- package/docs/interfaces/ChannelInvite.html +5 -5
- package/docs/interfaces/ChannelMember.html +8 -8
- package/docs/interfaces/ChannelPermissionsInput.html +10 -10
- package/docs/interfaces/ChannelSortOrder.html +6 -6
- package/docs/interfaces/ChannelsModule.html +65 -65
- package/docs/interfaces/ChatMention.html +4 -4
- package/docs/interfaces/ChatNotificationRules.html +2 -2
- package/docs/interfaces/ChatSummary.html +12 -12
- package/docs/interfaces/ClearRecipientChatRulesInput.html +6 -6
- package/docs/interfaces/CreateBackupInput.html +4 -4
- package/docs/interfaces/CreateChannelInput.html +20 -20
- package/docs/interfaces/CreateChatInput.html +6 -6
- package/docs/interfaces/CreateGroupInput.html +12 -12
- package/docs/interfaces/CreatePollInput.html +14 -14
- package/docs/interfaces/DeclineChannelInvitationInput.html +6 -6
- package/docs/interfaces/DeclineGroupInvitationInput.html +6 -6
- package/docs/interfaces/DeclineInvitationInput.html +6 -6
- package/docs/interfaces/DeclineInvitationRequestInput.html +10 -10
- package/docs/interfaces/DeclineVerificationInput.html +4 -4
- package/docs/interfaces/DeleteChannelInput.html +5 -5
- package/docs/interfaces/DeleteGroupInput.html +6 -6
- package/docs/interfaces/DeleteMessageInput.html +10 -10
- package/docs/interfaces/DeleteOwnRedactReason.html +6 -6
- package/docs/interfaces/DirectChat.html +6 -6
- package/docs/interfaces/DirectChatInvitation.html +6 -6
- package/docs/interfaces/DirectChatInvite.html +5 -5
- package/docs/interfaces/DirectChatsModule.html +22 -22
- package/docs/interfaces/DownloadMediaFileInput.html +10 -10
- package/docs/interfaces/EditMessageInput.html +10 -10
- package/docs/interfaces/EditPollInput.html +16 -16
- package/docs/interfaces/EditReactionRedactReason.html +4 -4
- package/docs/interfaces/Emote.html +9 -9
- package/docs/interfaces/EncryptedMessage.html +7 -7
- package/docs/interfaces/EndPollInput.html +8 -8
- package/docs/interfaces/EventListenerContent.html +8 -8
- package/docs/interfaces/EventListenerReaction.html +10 -10
- package/docs/interfaces/EventNotificationRules.html +2 -2
- package/docs/interfaces/File.html +13 -13
- package/docs/interfaces/FileEncryptionInfo.html +10 -10
- package/docs/interfaces/FileMedia.html +5 -5
- package/docs/interfaces/GetBackupStateInput.html +4 -4
- package/docs/interfaces/GetChannelInput.html +6 -6
- package/docs/interfaces/GetChannelMembersInput.html +6 -6
- package/docs/interfaces/GetChannelMembershipInput.html +6 -6
- package/docs/interfaces/GetChannelsInput.html +6 -6
- package/docs/interfaces/GetChatSummariesInput.html +6 -6
- package/docs/interfaces/GetDecodedInfoInput.html +8 -8
- package/docs/interfaces/GetGroupInput.html +6 -6
- package/docs/interfaces/GetGroupMembersInput.html +6 -6
- package/docs/interfaces/GetGroupsInput.html +6 -6
- package/docs/interfaces/GetMessageInput.html +8 -8
- package/docs/interfaces/GetMessagesInput.html +10 -10
- package/docs/interfaces/GetPinnedMessagesInput.html +6 -6
- package/docs/interfaces/GetPollResponsesInput.html +8 -8
- package/docs/interfaces/GetSettingsInput.html +4 -4
- package/docs/interfaces/Group.html +14 -14
- package/docs/interfaces/GroupInvite.html +5 -5
- package/docs/interfaces/GroupMember.html +8 -8
- package/docs/interfaces/GroupsModule.html +43 -43
- package/docs/interfaces/Handle.html +6 -6
- package/docs/interfaces/HandleMention.html +8 -8
- package/docs/interfaces/HandleStorage.html +6 -6
- package/docs/interfaces/HandlesModule.html +12 -12
- package/docs/interfaces/HashAlgorithmMap.html +4 -4
- package/docs/interfaces/Image.html +19 -19
- package/docs/interfaces/ImageMedia.html +9 -9
- package/docs/interfaces/Input.html +3 -3
- package/docs/interfaces/Invite.html +4 -4
- package/docs/interfaces/IsVerifiedInput.html +4 -4
- package/docs/interfaces/JoinChannelInput.html +6 -6
- package/docs/interfaces/KeyVerificationRequest.html +18 -18
- package/docs/interfaces/KickChannelHandleInput.html +10 -10
- package/docs/interfaces/KickGroupHandleInput.html +10 -10
- package/docs/interfaces/LeaveChannelInput.html +6 -6
- package/docs/interfaces/LeaveGroupInput.html +6 -6
- package/docs/interfaces/ListHandlesInput.html +6 -6
- package/docs/interfaces/ListReceivedInvitationRequestsInput.html +6 -6
- package/docs/interfaces/Location.html +11 -11
- package/docs/interfaces/MarkAsReadInput.html +6 -6
- package/docs/interfaces/MediaModule.html +5 -5
- package/docs/interfaces/Member.html +6 -6
- package/docs/interfaces/MembershipChange.html +14 -14
- package/docs/interfaces/Message.html +20 -20
- package/docs/interfaces/MessageNotification.html +5 -5
- package/docs/interfaces/MessageReaction.html +8 -8
- package/docs/interfaces/MessageReceipt.html +6 -6
- package/docs/interfaces/MessagingModule.html +50 -50
- package/docs/interfaces/ModerationRedactReason.html +10 -10
- package/docs/interfaces/Notice.html +9 -9
- package/docs/interfaces/NotificationInfo.html +4 -4
- package/docs/interfaces/NotificationSettings.html +4 -4
- package/docs/interfaces/NotificationsModule.html +16 -16
- package/docs/interfaces/OnSessionVerificationChangedInput.html +6 -6
- package/docs/interfaces/OnVerificationRequestReceivedInput.html +6 -6
- package/docs/interfaces/OwnedHandle.html +10 -10
- package/docs/interfaces/Pagination.html +6 -6
- package/docs/interfaces/PinMessageInput.html +8 -8
- package/docs/interfaces/PlatformNotificationDataTemplate.html +6 -6
- package/docs/interfaces/Poll.html +15 -15
- package/docs/interfaces/PollResponse.html +11 -11
- package/docs/interfaces/PollResponses.html +8 -8
- package/docs/interfaces/ProvisionHandleInput.html +8 -8
- package/docs/interfaces/PublicChannelSearchInput.html +18 -18
- package/docs/interfaces/PublicChannelSearchResult.html +20 -20
- package/docs/interfaces/Recipient.html +4 -4
- package/docs/interfaces/RecoverInput.html +6 -6
- package/docs/interfaces/RedactedMessage.html +12 -12
- package/docs/interfaces/RegisterMessageListenerInput.html +10 -10
- package/docs/interfaces/RequestVerificationInput.html +4 -4
- package/docs/interfaces/ResetBackupKeyInput.html +4 -4
- package/docs/interfaces/RotateBackupKeyInput.html +4 -4
- package/docs/interfaces/SearchMessagesInput.html +10 -10
- package/docs/interfaces/SearchMessagesItem.html +18 -18
- package/docs/interfaces/SecureCommsClient.html +28 -28
- package/docs/interfaces/SecureCommsSession.html +18 -18
- package/docs/interfaces/SecureCommsStore.html +8 -8
- package/docs/interfaces/SecurityModule.html +35 -35
- package/docs/interfaces/SelfDestructInfo.html +8 -8
- package/docs/interfaces/SelfDestructedMessage.html +10 -10
- package/docs/interfaces/SendChannelInvitationsInput.html +8 -8
- package/docs/interfaces/SendGroupInvitationsInput.html +8 -8
- package/docs/interfaces/SendInvitationRequestInput.html +8 -8
- package/docs/interfaces/SendMediaInput.html +26 -26
- package/docs/interfaces/SendMessageInput.html +18 -18
- package/docs/interfaces/SendPollResponseInput.html +10 -10
- package/docs/interfaces/SendTypingNotificationInput.html +8 -8
- package/docs/interfaces/SessionAPIs.html +5 -5
- package/docs/interfaces/SetDefaultChatRulesInput.html +6 -6
- package/docs/interfaces/SetDefaultEventRulesInput.html +6 -6
- package/docs/interfaces/SetRecipientChatRulesInput.html +8 -8
- package/docs/interfaces/StartVerificationInput.html +4 -4
- package/docs/interfaces/StorageModule.html +10 -10
- package/docs/interfaces/StorageProvider.html +32 -32
- package/docs/interfaces/StorageProviderFactory.html +2 -2
- package/docs/interfaces/Text.html +9 -9
- package/docs/interfaces/ThumbnailInfo.html +12 -12
- package/docs/interfaces/ToggleReactionInput.html +10 -10
- package/docs/interfaces/UnbanChannelHandleInput.html +9 -9
- package/docs/interfaces/UnbanGroupHandleInput.html +10 -10
- package/docs/interfaces/UnblockHandleInput.html +6 -6
- package/docs/interfaces/UnknownRedactReason.html +4 -4
- package/docs/interfaces/UnpinMessageInput.html +8 -8
- package/docs/interfaces/UnreadCount.html +6 -6
- package/docs/interfaces/UnregisterMessageListenerInput.html +8 -8
- package/docs/interfaces/UpdateChannelInput.html +20 -20
- package/docs/interfaces/UpdateChannelMemberRoleInput.html +10 -10
- package/docs/interfaces/UpdateGroupInput.html +12 -12
- package/docs/interfaces/UpdateGroupMemberRoleInput.html +10 -10
- package/docs/interfaces/UpdateHandleInput.html +6 -6
- package/docs/interfaces/Video.html +19 -19
- package/docs/interfaces/VideoMedia.html +11 -11
- package/docs/interfaces/WithdrawChannelInvitationInput.html +8 -8
- package/docs/interfaces/WithdrawGroupInvitationInput.html +8 -8
- package/docs/interfaces/WithdrawInvitationRequestInput.html +6 -6
- package/docs/modules.html +1 -1
- package/docs/types/MediaInfo.html +2 -2
- package/docs/types/MessageContent.html +2 -2
- package/docs/types/MessageMention.html +2 -2
- package/docs/types/RedactReason.html +2 -2
- package/docs/types/SecureCommsClientOptions.html +9 -5
- package/lib/private/data/common/apiClient.js +21 -35
- package/lib/private/data/common/apiClient.js.map +1 -1
- package/lib/private/data/common/transformer/errorTransformer.js +6 -4
- package/lib/private/data/common/transformer/errorTransformer.js.map +1 -1
- package/lib/private/data/session/sessionManager.js +2 -2
- package/lib/private/data/session/sessionManager.js.map +1 -1
- package/lib/public/errors.js +6 -1
- package/lib/public/errors.js.map +1 -1
- package/package.json +28 -31
- package/types/private/data/common/apiClient.d.ts +1 -0
- package/types/private/data/common/transformer/errorTransformer.d.ts +6 -2
- package/types/public/errors.d.ts +4 -1
- package/docs/classes/InvalidHandleError.html +0 -33
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
<a href="
|
|
3
|
-
<a href="
|
|
4
|
-
<a href="
|
|
5
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><
|
|
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>DirectChatInvite | @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">DirectChatInvite</a></li></ul><h1>Interface DirectChatInvite</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DirectChatInvite</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#chatid">chatId</a><span class="tsd-signature-symbol">:</span> <a href="../classes/ChatId.html" class="tsd-signature-type tsd-kind-class">ChatId</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#handleid">handleId</a><span class="tsd-signature-symbol">:</span> <a href="../classes/HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#recipient">recipient</a><span class="tsd-signature-symbol">:</span> <a href="Recipient.html" class="tsd-signature-type tsd-kind-interface">Recipient</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/NotificationInfoType.html" class="tsd-signature-type tsd-kind-enum">NotificationInfoType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="2083"><h4>Hierarchy (<a href="../hierarchy.html#DirectChatInvite">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="Invite.html" class="tsd-signature-type tsd-kind-interface">Invite</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">DirectChatInvite</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/typings/notification.ts:62</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#chatid" 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>chat<wbr/>Id</span></a>
|
|
2
|
+
<a href="#handleid" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handle<wbr/>Id</span></a>
|
|
3
|
+
<a href="#recipient" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>recipient</span></a>
|
|
4
|
+
<a href="#type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
5
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="chatid"><span>chat<wbr/>Id</span><a href="#chatid" 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">chatId</span><span class="tsd-signature-symbol">:</span> <a href="../classes/ChatId.html" class="tsd-signature-type tsd-kind-class">ChatId</a></div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/notification.ts:63</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="handleid"><span>handle<wbr/>Id</span><a href="#handleid" 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">handleId</span><span class="tsd-signature-symbol">:</span> <a href="../classes/HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a></div><aside class="tsd-sources"><p>Inherited from <a href="Invite.html">Invite</a>.<a href="Invite.html#handleid">handleId</a></p><ul><li>Defined in src/public/typings/notification.ts:51</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="recipient"><span>recipient</span><a href="#recipient" 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">recipient</span><span class="tsd-signature-symbol">:</span> <a href="Recipient.html" class="tsd-signature-type tsd-kind-interface">Recipient</a></div><aside class="tsd-sources"><p>Inherited from <a href="Invite.html">Invite</a>.<a href="Invite.html#recipient">recipient</a></p><ul><li>Defined in src/public/typings/notification.ts:53</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/NotificationInfoType.html" class="tsd-signature-type tsd-kind-enum">NotificationInfoType</a></div><aside class="tsd-sources"><p>Inherited from <a href="Invite.html">Invite</a>.<a href="Invite.html#type">type</a></p><ul><li>Defined in src/public/typings/notification.ts:52</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#chatid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>chat<wbr/>Id</span></a><a href="#handleid" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handle<wbr/>Id</span></a><a href="#recipient" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>recipient</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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,33 +1,33 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
</div
|
|
3
|
-
<a href="
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
6
|
-
<a href="
|
|
7
|
-
<a href="
|
|
8
|
-
<a href="
|
|
9
|
-
<a href="
|
|
10
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><
|
|
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>DirectChatsModule | @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">DirectChatsModule</a></li></ul><h1>Interface DirectChatsModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Direct Chat management for the Secure Communications Service.</p>
|
|
2
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DirectChatsModule</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#acceptinvitation-1">acceptInvitation</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="AcceptInvitationInput.html" class="tsd-signature-type tsd-kind-interface">AcceptInvitationInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#blockhandle-1">blockHandle</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="BlockHandleInput.html" class="tsd-signature-type tsd-kind-interface">BlockHandleInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#createchat-1">createChat</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="CreateChatInput.html" class="tsd-signature-type tsd-kind-interface">CreateChatInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/ChatId.html" class="tsd-signature-type tsd-kind-class">ChatId</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#declineinvitation-1">declineInvitation</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="DeclineInvitationInput.html" class="tsd-signature-type tsd-kind-interface">DeclineInvitationInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#listblockedhandles-1">listBlockedHandles</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <a href="../classes/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"><</span><a href="../classes/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-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#listinvitations-1">listInvitations</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <a href="../classes/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"><</span><a href="DirectChatInvitation.html" class="tsd-signature-type tsd-kind-interface">DirectChatInvitation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#listjoined-1">listJoined</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <a href="../classes/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"><</span><a href="DirectChat.html" class="tsd-signature-type tsd-kind-interface">DirectChat</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#unblockhandle-1">unblockHandle</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="UnblockHandleInput.html" class="tsd-signature-type tsd-kind-interface">UnblockHandleInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/DefaultDirectChatsModule.html" class="tsd-signature-type tsd-kind-class">DefaultDirectChatsModule</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/directChatsModule.ts:86</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#acceptinvitation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>accept<wbr/>Invitation</span></a>
|
|
3
|
+
<a href="#blockhandle" 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>block<wbr/>Handle</span></a>
|
|
4
|
+
<a href="#createchat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Chat</span></a>
|
|
5
|
+
<a href="#declineinvitation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>decline<wbr/>Invitation</span></a>
|
|
6
|
+
<a href="#listblockedhandles" 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>list<wbr/>Blocked<wbr/>Handles</span></a>
|
|
7
|
+
<a href="#listinvitations" 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>list<wbr/>Invitations</span></a>
|
|
8
|
+
<a href="#listjoined" 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>list<wbr/>Joined</span></a>
|
|
9
|
+
<a href="#unblockhandle" 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>unblock<wbr/>Handle</span></a>
|
|
10
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="acceptinvitation"><span>accept<wbr/>Invitation</span><a href="#acceptinvitation" 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="acceptinvitation-1"><span class="tsd-kind-call-signature">acceptInvitation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="AcceptInvitationInput.html" class="tsd-signature-type tsd-kind-interface">AcceptInvitationInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#acceptinvitation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Accept an invitation to join a direct chat.</p>
|
|
11
11
|
</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="AcceptInvitationInput.html" class="tsd-signature-type tsd-kind-interface">AcceptInvitationInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to accept an invitation
|
|
12
12
|
to join a direct chat.</p>
|
|
13
|
-
</div
|
|
13
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/directChatsModule.ts:101</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="blockhandle"><span>block<wbr/>Handle</span><a href="#blockhandle" 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="blockhandle-1"><span class="tsd-kind-call-signature">blockHandle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="BlockHandleInput.html" class="tsd-signature-type tsd-kind-interface">BlockHandleInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#blockhandle-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>Blocks a handle.</p>
|
|
14
14
|
</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="BlockHandleInput.html" class="tsd-signature-type tsd-kind-interface">BlockHandleInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to block a handle.</p>
|
|
15
|
-
</div
|
|
15
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/directChatsModule.ts:132</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createchat"><span>create<wbr/>Chat</span><a href="#createchat" 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="createchat-1"><span class="tsd-kind-call-signature">createChat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="CreateChatInput.html" class="tsd-signature-type tsd-kind-interface">CreateChatInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/ChatId.html" class="tsd-signature-type tsd-kind-class">ChatId</a><span class="tsd-signature-symbol">></span><a href="#createchat-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>Creates a direct chat with another handle.</p>
|
|
16
16
|
</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="CreateChatInput.html" class="tsd-signature-type tsd-kind-interface">CreateChatInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to create a new direct chat.</p>
|
|
17
|
-
</div
|
|
18
|
-
<
|
|
17
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/ChatId.html" class="tsd-signature-type tsd-kind-class">ChatId</a><span class="tsd-signature-symbol">></span></h4><p>The identifier of the direct chat.</p>
|
|
18
|
+
<aside class="tsd-sources"><ul><li>Defined in src/public/modules/directChatsModule.ts:93</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="declineinvitation"><span>decline<wbr/>Invitation</span><a href="#declineinvitation" 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="declineinvitation-1"><span class="tsd-kind-call-signature">declineInvitation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="DeclineInvitationInput.html" class="tsd-signature-type tsd-kind-interface">DeclineInvitationInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#declineinvitation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Decline an invitation to join a direct chat.</p>
|
|
19
19
|
</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="DeclineInvitationInput.html" class="tsd-signature-type tsd-kind-interface">DeclineInvitationInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to decline an invitation
|
|
20
20
|
to join a direct chat.</p>
|
|
21
|
-
</div
|
|
21
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/directChatsModule.ts:109</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listblockedhandles"><span>list<wbr/>Blocked<wbr/>Handles</span><a href="#listblockedhandles" 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="listblockedhandles-1"><span class="tsd-kind-call-signature">listBlockedHandles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <a href="../classes/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"><</span><a href="../classes/HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listblockedhandles-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>Retrieves a list of all known blocked handles for this handle.</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">handleId</span>: <a href="../classes/HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a></span><div class="tsd-comment tsd-typography"><p>Identifier of the handle owned by this client.</p>
|
|
23
|
-
</div
|
|
23
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A list of the handle identifiers of the handles
|
|
24
24
|
that are blocked.</p>
|
|
25
|
-
<
|
|
25
|
+
<aside class="tsd-sources"><ul><li>Defined in src/public/modules/directChatsModule.ts:148</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listinvitations"><span>list<wbr/>Invitations</span><a href="#listinvitations" 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="listinvitations-1"><span class="tsd-kind-call-signature">listInvitations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <a href="../classes/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"><</span><a href="DirectChatInvitation.html" class="tsd-signature-type tsd-kind-interface">DirectChatInvitation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listinvitations-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>Retrieves a list of all direct chats that this handle has an invitation for.</p>
|
|
26
26
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handleId</span>: <a href="../classes/HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a></span><div class="tsd-comment tsd-typography"><p>Identifier of the handle owned by this client.</p>
|
|
27
|
-
</div
|
|
28
|
-
<
|
|
27
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="DirectChatInvitation.html" class="tsd-signature-type tsd-kind-interface">DirectChatInvitation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A list of direct chat invitations for this handle.</p>
|
|
28
|
+
<aside class="tsd-sources"><ul><li>Defined in src/public/modules/directChatsModule.ts:117</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listjoined"><span>list<wbr/>Joined</span><a href="#listjoined" 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="listjoined-1"><span class="tsd-kind-call-signature">listJoined</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <a href="../classes/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"><</span><a href="DirectChat.html" class="tsd-signature-type tsd-kind-interface">DirectChat</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listjoined-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>Retrieves a list of all direct chats that this handle has joined.</p>
|
|
29
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">handleId</span>: <a href="../classes/HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a></span><div class="tsd-comment tsd-typography"><p>Identifier of the handle owned by this client.</p>
|
|
30
|
-
</div
|
|
31
|
-
<
|
|
30
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="DirectChat.html" class="tsd-signature-type tsd-kind-interface">DirectChat</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A list of direct chats that this handle has joined.</p>
|
|
31
|
+
<aside class="tsd-sources"><ul><li>Defined in src/public/modules/directChatsModule.ts:125</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="unblockhandle"><span>unblock<wbr/>Handle</span><a href="#unblockhandle" 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="unblockhandle-1"><span class="tsd-kind-call-signature">unblockHandle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="UnblockHandleInput.html" class="tsd-signature-type tsd-kind-interface">UnblockHandleInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#unblockhandle-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>Unblocks a handle.</p>
|
|
32
32
|
</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="UnblockHandleInput.html" class="tsd-signature-type tsd-kind-interface">UnblockHandleInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to unblock a handle</p>
|
|
33
|
-
</div
|
|
33
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/directChatsModule.ts:139</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#acceptinvitation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>accept<wbr/>Invitation</span></a><a href="#blockhandle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>block<wbr/>Handle</span></a><a href="#createchat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Chat</span></a><a href="#declineinvitation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>decline<wbr/>Invitation</span></a><a href="#listblockedhandles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Blocked<wbr/>Handles</span></a><a href="#listinvitations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Invitations</span></a><a href="#listjoined"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Joined</span></a><a href="#unblockhandle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unblock<wbr/>Handle</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,12 +1,12 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DownloadMediaFileInput | @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">DownloadMediaFileInput</a></li></ul><h1>Interface DownloadMediaFileInput</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Input for downloading a media file.</p>
|
|
2
2
|
<p>DownloadMediaFileInput</p>
|
|
3
|
-
</div
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
6
|
-
<a href="
|
|
7
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><
|
|
3
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DownloadMediaFileInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#encryptioninfo">encryptionInfo</a><span class="tsd-signature-symbol">?:</span> <a href="FileEncryptionInfo.html" class="tsd-signature-type tsd-kind-interface">FileEncryptionInfo</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#filename">filename</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#handleid">handleId</a><span class="tsd-signature-symbol">:</span> <a href="../classes/HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#uri">uri</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/mediaModule.ts:26</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#encryptioninfo" 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>encryption<wbr/>Info?</span></a>
|
|
4
|
+
<a href="#filename" 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>filename?</span></a>
|
|
5
|
+
<a href="#handleid" 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>handle<wbr/>Id</span></a>
|
|
6
|
+
<a href="#uri" 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>uri</span></a>
|
|
7
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="encryptioninfo"><code class="tsd-tag">Optional</code><span>encryption<wbr/>Info</span><a href="#encryptioninfo" 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">encryptionInfo</span><span class="tsd-signature-symbol">?:</span> <a href="FileEncryptionInfo.html" class="tsd-signature-type tsd-kind-interface">FileEncryptionInfo</a></div><div class="tsd-comment tsd-typography"><p>The optional encryption material used to decrypt
|
|
8
8
|
the media file.</p>
|
|
9
|
-
</div><
|
|
10
|
-
</div><
|
|
11
|
-
</div><
|
|
12
|
-
</div><
|
|
9
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/mediaModule.ts:30</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filename"><code class="tsd-tag">Optional</code><span>filename</span><a href="#filename" 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">filename</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The optional file name of the media.</p>
|
|
10
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/mediaModule.ts:29</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="handleid"><span>handle<wbr/>Id</span><a href="#handleid" 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">handleId</span><span class="tsd-signature-symbol">:</span> <a href="../classes/HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a></div><div class="tsd-comment tsd-typography"><p>Identifier of the handle owned by this client.</p>
|
|
11
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/mediaModule.ts:27</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="uri"><span>uri</span><a href="#uri" 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">uri</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>URI of the media to download.</p>
|
|
12
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/mediaModule.ts:28</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#encryptioninfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encryption<wbr/>Info</span></a><a href="#filename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filename</span></a><a href="#handleid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handle<wbr/>Id</span></a><a href="#uri"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uri</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>
|