@sudoplatform/sudo-secure-communications 5.2.5 → 5.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/private/data/common/matrixClientManager.js +24 -2
- package/cjs/private/data/common/matrixClientManager.js.map +1 -1
- package/cjs/private/data/messaging/matrixMessagingService.js +81 -26
- package/cjs/private/data/messaging/matrixMessagingService.js.map +1 -1
- package/cjs/private/data/messaging/transformer/messageTransformer.js +8 -4
- package/cjs/private/data/messaging/transformer/messageTransformer.js.map +1 -1
- package/cjs/private/domain/use-cases/messaging/editMediaCaptionUseCase.js +43 -0
- package/cjs/private/domain/use-cases/messaging/editMediaCaptionUseCase.js.map +1 -0
- package/cjs/private/domain/use-cases/messaging/sendMediaUseCase.js +2 -0
- package/cjs/private/domain/use-cases/messaging/sendMediaUseCase.js.map +1 -1
- package/cjs/public/modules/messagingModule.js +8 -0
- package/cjs/public/modules/messagingModule.js.map +1 -1
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/DefaultMessagingModule.html +27 -23
- package/docs/hierarchy.html +1 -1
- package/docs/interfaces/Audio.html +7 -5
- package/docs/interfaces/AudioMedia.html +1 -1
- package/docs/interfaces/BaseMessageContent.html +1 -1
- package/docs/interfaces/ChannelInvite.html +1 -1
- package/docs/interfaces/ChannelMember.html +1 -1
- package/docs/interfaces/CreatePollInput.html +7 -7
- package/docs/interfaces/DeleteMessageInput.html +5 -5
- package/docs/interfaces/DirectChatInvite.html +1 -1
- package/docs/interfaces/EditMediaCaptionInput.html +13 -0
- package/docs/interfaces/EditMessageInput.html +5 -5
- package/docs/interfaces/EditPollInput.html +8 -8
- package/docs/interfaces/EditedMessage.html +1 -1
- package/docs/interfaces/Emote.html +1 -1
- package/docs/interfaces/EncryptedMessage.html +1 -1
- package/docs/interfaces/EndPollInput.html +4 -4
- package/docs/interfaces/EventListenerContent.html +4 -4
- package/docs/interfaces/EventListenerReaction.html +6 -6
- package/docs/interfaces/File.html +7 -5
- package/docs/interfaces/FileMedia.html +1 -1
- package/docs/interfaces/GetChatSummariesInput.html +3 -3
- package/docs/interfaces/GetMessageInput.html +4 -4
- package/docs/interfaces/GetMessagesInput.html +3 -3
- package/docs/interfaces/GetPinnedMessagesInput.html +3 -3
- package/docs/interfaces/GetPollResponsesInput.html +4 -4
- package/docs/interfaces/GroupInvite.html +1 -1
- package/docs/interfaces/GroupMember.html +1 -1
- package/docs/interfaces/Handle.html +1 -1
- package/docs/interfaces/Image.html +1 -1
- package/docs/interfaces/ImageMedia.html +1 -1
- package/docs/interfaces/Invite.html +1 -1
- package/docs/interfaces/KeyVerificationRequest.html +1 -1
- package/docs/interfaces/Location.html +3 -3
- package/docs/interfaces/MarkAsReadInput.html +3 -3
- package/docs/interfaces/Member.html +1 -1
- package/docs/interfaces/MembershipChange.html +1 -1
- package/docs/interfaces/MessageNotification.html +1 -1
- package/docs/interfaces/MessagingModule.html +26 -22
- package/docs/interfaces/Notice.html +1 -1
- package/docs/interfaces/NotificationInfo.html +1 -1
- package/docs/interfaces/OwnedHandle.html +1 -1
- package/docs/interfaces/Pagination.html +1 -1
- package/docs/interfaces/PinMessageInput.html +4 -4
- package/docs/interfaces/Poll.html +5 -5
- package/docs/interfaces/PollResponse.html +3 -3
- package/docs/interfaces/RedactedMessage.html +1 -1
- package/docs/interfaces/RegisterMessageListenerInput.html +5 -5
- package/docs/interfaces/SearchMessagesInput.html +3 -3
- package/docs/interfaces/SelfDestructInfo.html +4 -4
- package/docs/interfaces/SelfDestructedMessage.html +1 -1
- package/docs/interfaces/SelfDestructible.html +1 -1
- package/docs/interfaces/SendMediaInput.html +18 -14
- package/docs/interfaces/SendMessageInput.html +9 -9
- package/docs/interfaces/SendPollResponseInput.html +5 -5
- package/docs/interfaces/SendTypingNotificationInput.html +4 -4
- package/docs/interfaces/Text.html +1 -1
- package/docs/interfaces/ThumbnailInfo.html +6 -6
- package/docs/interfaces/ToggleReactionInput.html +5 -5
- package/docs/interfaces/UnpinMessageInput.html +4 -4
- package/docs/interfaces/UnregisterMessageListenerInput.html +4 -4
- package/docs/interfaces/Video.html +1 -1
- package/docs/interfaces/VideoMedia.html +1 -1
- package/docs/modules.html +1 -1
- package/lib/private/data/common/matrixClientManager.js +24 -2
- package/lib/private/data/common/matrixClientManager.js.map +1 -1
- package/lib/private/data/messaging/matrixMessagingService.js +82 -27
- package/lib/private/data/messaging/matrixMessagingService.js.map +1 -1
- package/lib/private/data/messaging/transformer/messageTransformer.js +8 -4
- package/lib/private/data/messaging/transformer/messageTransformer.js.map +1 -1
- package/lib/private/domain/use-cases/messaging/editMediaCaptionUseCase.js +39 -0
- package/lib/private/domain/use-cases/messaging/editMediaCaptionUseCase.js.map +1 -0
- package/lib/private/domain/use-cases/messaging/sendMediaUseCase.js +2 -0
- package/lib/private/domain/use-cases/messaging/sendMediaUseCase.js.map +1 -1
- package/lib/public/modules/messagingModule.js +8 -0
- package/lib/public/modules/messagingModule.js.map +1 -1
- package/package.json +131 -20
- package/types/private/data/messaging/matrixMessagingService.d.ts +3 -1
- package/types/private/domain/entities/messaging/messagingService.d.ts +19 -0
- package/types/private/domain/use-cases/messaging/editMediaCaptionUseCase.d.ts +28 -0
- package/types/private/domain/use-cases/messaging/sendMediaUseCase.d.ts +3 -0
- package/types/public/modules/messagingModule.d.ts +29 -0
- package/types/public/typings/messageContent.d.ts +4 -0
|
@@ -1,13 +1,13 @@
|
|
|
1
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>SearchMessagesInput | @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">SearchMessagesInput</a></li></ul><h1>Interface SearchMessagesInput</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Properties required to search for all messages in unencrypted channels/groups.</p>
|
|
2
2
|
<p>SearchMessagesInput</p>
|
|
3
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SearchMessagesInput</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="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nexttoken">nextToken</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="#searchtext">searchText</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><section class="tsd-panel tsd-hierarchy" data-refl="1016"><h4>Hierarchy (<a href="../hierarchy.html#SearchMessagesInput">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="Pagination.html" class="tsd-signature-type tsd-kind-interface">Pagination</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SearchMessagesInput</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
3
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SearchMessagesInput</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="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nexttoken">nextToken</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="#searchtext">searchText</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><section class="tsd-panel tsd-hierarchy" data-refl="1016"><h4>Hierarchy (<a href="../hierarchy.html#SearchMessagesInput">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="Pagination.html" class="tsd-signature-type tsd-kind-interface">Pagination</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SearchMessagesInput</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:88</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="#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>
|
|
4
4
|
<a href="#limit" 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>limit?</span></a>
|
|
5
5
|
<a href="#nexttoken" 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>next<wbr/>Token?</span></a>
|
|
6
6
|
<a href="#searchtext" 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>search<wbr/>Text</span></a>
|
|
7
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="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>
|
|
8
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
8
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:89</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="limit"><code class="tsd-tag">Optional</code><span>limit</span><a href="#limit" 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">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Number of items to return. Will be defaulted if omitted.</p>
|
|
9
9
|
</div><aside class="tsd-sources"><p>Inherited from <a href="Pagination.html">Pagination</a>.<a href="Pagination.html#limit">limit</a></p><ul><li>Defined in src/public/secureCommsClient.ts:60</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="nexttoken"><code class="tsd-tag">Optional</code><span>next<wbr/>Token</span><a href="#nexttoken" 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">nextToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A token generated by a previous call.</p>
|
|
10
10
|
</div><aside class="tsd-sources"><p>Inherited from <a href="Pagination.html">Pagination</a>.<a href="Pagination.html#nexttoken">nextToken</a></p><ul><li>Defined in src/public/secureCommsClient.ts:61</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="searchtext"><span>search<wbr/>Text</span><a href="#searchtext" 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">searchText</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The text to search and match messages with. Search keywords
|
|
11
11
|
are matched as case-insensitive and whole-words only. Multiple search terms are supported
|
|
12
12
|
in any order.</p>
|
|
13
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
13
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:90</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="#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="#limit" 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>limit</span></a><a href="#nexttoken" 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>next<wbr/>Token</span></a><a href="#searchtext"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>search<wbr/>Text</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-secure-communications</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SelfDestructInfo | @sudoplatform/sudo-secure-communications</title><meta name="description" content="Documentation for @sudoplatform/sudo-secure-communications"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-secure-communications</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">SelfDestructInfo</a></li></ul><h1>Interface SelfDestructInfo</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Self-destruct information for a message.</p>
|
|
2
2
|
<p>SelfDestructInfo</p>
|
|
3
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SelfDestructInfo</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#clientduration">clientDuration</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clientexpiry">clientExpiry</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#serverexpiry">serverExpiry</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:
|
|
3
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SelfDestructInfo</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#clientduration">clientDuration</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clientexpiry">clientExpiry</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#serverexpiry">serverExpiry</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:305</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#clientduration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Duration?</span></a>
|
|
4
4
|
<a href="#clientexpiry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Expiry?</span></a>
|
|
5
5
|
<a href="#serverexpiry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Expiry?</span></a>
|
|
6
6
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clientduration"><code class="tsd-tag">Optional</code><span>client<wbr/>Duration</span><a href="#clientduration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clientDuration</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The length of time this message should be available.
|
|
7
7
|
If undefined, the message should be available indefinitely.</p>
|
|
8
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:
|
|
9
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:
|
|
8
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:306</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clientexpiry"><code class="tsd-tag">Optional</code><span>client<wbr/>Expiry</span><a href="#clientexpiry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clientExpiry</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The client-side expiry time of this message.</p>
|
|
9
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:307</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="serverexpiry"><code class="tsd-tag">Optional</code><span>server<wbr/>Expiry</span><a href="#serverexpiry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">serverExpiry</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The expiry time of this message on the server. After this time, the
|
|
10
10
|
server removes the contents of the message.</p>
|
|
11
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:
|
|
11
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:308</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#clientduration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Duration</span></a><a href="#clientexpiry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Expiry</span></a><a href="#serverexpiry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Expiry</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-secure-communications</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,7 +1,7 @@
|
|
|
1
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>SelfDestructedMessage | @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">SelfDestructedMessage</a></li></ul><h1>Interface SelfDestructedMessage</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Self-destructed message content. Messages of this type have had their previous content
|
|
2
2
|
removed due to "self-destructing" after their expiry time.</p>
|
|
3
3
|
<p>SelfDestructedMessage</p>
|
|
4
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SelfDestructedMessage</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#isedited">isEdited</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repliedtomessageid">repliedToMessageId</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="#threadid">threadId</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="#type">type</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><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
4
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SelfDestructedMessage</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#isedited">isEdited</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repliedtomessageid">repliedToMessageId</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="#threadid">threadId</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="#type">type</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><section class="tsd-panel tsd-hierarchy" data-refl="1955"><h4>Hierarchy (<a href="../hierarchy.html#SelfDestructedMessage">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BaseMessageContent.html" class="tsd-signature-type tsd-kind-interface">BaseMessageContent</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SelfDestructedMessage</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:88</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="#isedited" 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>is<wbr/>Edited</span></a>
|
|
5
5
|
<a href="#repliedtomessageid" 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>replied<wbr/>To<wbr/>Message<wbr/>Id?</span></a>
|
|
6
6
|
<a href="#threadid" 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>thread<wbr/>Id?</span></a>
|
|
7
7
|
<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>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
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>SelfDestructible | @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">SelfDestructible</a></li></ul><h1>Interface SelfDestructible</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Interface for messages that can self-destruct.</p>
|
|
2
2
|
<p>SelfDestructible</p>
|
|
3
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SelfDestructible</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#isedited">isEdited</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repliedtomessageid">repliedToMessageId</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="#selfdestructinfo">selfDestructInfo</a><span class="tsd-signature-symbol">?:</span> <a href="SelfDestructInfo.html" class="tsd-signature-type tsd-kind-interface">SelfDestructInfo</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#threadid">threadId</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="#type">type</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><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
3
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SelfDestructible</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#isedited">isEdited</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repliedtomessageid">repliedToMessageId</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="#selfdestructinfo">selfDestructInfo</a><span class="tsd-signature-symbol">?:</span> <a href="SelfDestructInfo.html" class="tsd-signature-type tsd-kind-interface">SelfDestructInfo</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#threadid">threadId</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="#type">type</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><section class="tsd-panel tsd-hierarchy" data-refl="1967"><h4>Hierarchy (<a href="../hierarchy.html#SelfDestructible">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BaseMessageContent.html" class="tsd-signature-type tsd-kind-interface">BaseMessageContent</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SelfDestructible</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="Emote.html" class="tsd-signature-type tsd-kind-interface">Emote</a></li><li class="tsd-hierarchy-item"><a href="Notice.html" class="tsd-signature-type tsd-kind-interface">Notice</a></li><li class="tsd-hierarchy-item"><a href="Text.html" class="tsd-signature-type tsd-kind-interface">Text</a></li><li class="tsd-hierarchy-item"><a href="Image.html" class="tsd-signature-type tsd-kind-interface">Image</a></li><li class="tsd-hierarchy-item"><a href="Video.html" class="tsd-signature-type tsd-kind-interface">Video</a></li><li class="tsd-hierarchy-item"><a href="Audio.html" class="tsd-signature-type tsd-kind-interface">Audio</a></li><li class="tsd-hierarchy-item"><a href="File.html" class="tsd-signature-type tsd-kind-interface">File</a></li><li class="tsd-hierarchy-item"><a href="Location.html" class="tsd-signature-type tsd-kind-interface">Location</a></li><li class="tsd-hierarchy-item"><a href="Poll.html" class="tsd-signature-type tsd-kind-interface">Poll</a></li><li class="tsd-hierarchy-item"><a href="PollResponse.html" class="tsd-signature-type tsd-kind-interface">PollResponse</a></li><li class="tsd-hierarchy-item"><a href="EncryptedMessage.html" class="tsd-signature-type tsd-kind-interface">EncryptedMessage</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/typings/messageContent.ts:108</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="#isedited" 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>is<wbr/>Edited</span></a>
|
|
4
4
|
<a href="#repliedtomessageid" 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>replied<wbr/>To<wbr/>Message<wbr/>Id?</span></a>
|
|
5
5
|
<a href="#selfdestructinfo" 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>self<wbr/>Destruct<wbr/>Info?</span></a>
|
|
6
6
|
<a href="#threadid" 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>thread<wbr/>Id?</span></a>
|
|
@@ -1,33 +1,37 @@
|
|
|
1
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>SendMediaInput | @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">SendMediaInput</a></li></ul><h1>Interface SendMediaInput</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Properties required to send a new media message.</p>
|
|
2
2
|
<p>SendMediaInput</p>
|
|
3
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SendMediaInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#clientmessageduration">clientMessageDuration</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#file">file</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArrayBuffer</span><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="#filesize">fileSize</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#filetype">fileType</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="#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="#replytomessageid">replyToMessageId</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="#servermessageduration">serverMessageDuration</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#threadid">threadId</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="#thumbnail">thumbnail</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#thumbnailinfo">thumbnailInfo</a><span class="tsd-signature-symbol">?:</span> <a href="ThumbnailInfo.html" class="tsd-signature-type tsd-kind-interface">ThumbnailInfo</a><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/messagingModule.ts:
|
|
3
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SendMediaInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#caption">caption</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="#clientmessageduration">clientMessageDuration</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#file">file</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArrayBuffer</span><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="#filesize">fileSize</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#filetype">fileType</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="#mentions">mentions</a><span class="tsd-signature-symbol">?:</span> <a href="../types/MessageMention.html" class="tsd-signature-type tsd-kind-type-alias">MessageMention</a><span class="tsd-signature-symbol">[]</span><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="#replytomessageid">replyToMessageId</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="#servermessageduration">serverMessageDuration</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#threadid">threadId</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="#thumbnail">thumbnail</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#thumbnailinfo">thumbnailInfo</a><span class="tsd-signature-symbol">?:</span> <a href="ThumbnailInfo.html" class="tsd-signature-type tsd-kind-interface">ThumbnailInfo</a><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/messagingModule.ts:221</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="#caption" 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>caption?</span></a>
|
|
4
|
+
<a href="#clientmessageduration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Message<wbr/>Duration?</span></a>
|
|
4
5
|
<a href="#file" 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>file</span></a>
|
|
5
6
|
<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>file<wbr/>Name</span></a>
|
|
6
7
|
<a href="#filesize" 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>file<wbr/>Size</span></a>
|
|
7
8
|
<a href="#filetype" 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>file<wbr/>Type</span></a>
|
|
8
9
|
<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>
|
|
10
|
+
<a href="#mentions" 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>mentions?</span></a>
|
|
9
11
|
<a href="#recipient" 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>recipient</span></a>
|
|
10
12
|
<a href="#replytomessageid" 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>reply<wbr/>To<wbr/>Message<wbr/>Id?</span></a>
|
|
11
13
|
<a href="#servermessageduration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Message<wbr/>Duration?</span></a>
|
|
12
14
|
<a href="#threadid" 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>thread<wbr/>Id?</span></a>
|
|
13
15
|
<a href="#thumbnail" 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>thumbnail?</span></a>
|
|
14
16
|
<a href="#thumbnailinfo" 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>thumbnail<wbr/>Info?</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-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="
|
|
17
|
+
</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="caption"><code class="tsd-tag">Optional</code><span>caption</span><a href="#caption" 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">caption</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>(Optional) The caption text for the media file.</p>
|
|
18
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:228</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clientmessageduration"><code class="tsd-tag">Optional</code><span>client<wbr/>Message<wbr/>Duration</span><a href="#clientmessageduration" 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">clientMessageDuration</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>(Optional) The locally managed duration this message should
|
|
16
19
|
exist client side before self-destructing.</p>
|
|
17
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
18
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
19
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
20
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
21
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
22
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
23
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
20
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:234</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="file"><span>file</span><a href="#file" 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">file</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArrayBuffer</span></div><div class="tsd-comment tsd-typography"><p>The media file to send.</p>
|
|
21
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:224</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filename"><span>file<wbr/>Name</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 name of the media file.</p>
|
|
22
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:225</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filesize"><span>file<wbr/>Size</span><a href="#filesize" 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">fileSize</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The size of the media file in bytes.</p>
|
|
23
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:227</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filetype"><span>file<wbr/>Type</span><a href="#filetype" 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">fileType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The MIME type of the media file.</p>
|
|
24
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:226</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>
|
|
25
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:222</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="mentions"><code class="tsd-tag">Optional</code><span>mentions</span><a href="#mentions" 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">mentions</span><span class="tsd-signature-symbol">?:</span> <a href="../types/MessageMention.html" class="tsd-signature-type tsd-kind-type-alias">MessageMention</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>(Optional) The list of mentions in the caption.</p>
|
|
26
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:229</li></ul></aside></section><section class="tsd-panel tsd-member"><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><div class="tsd-comment tsd-typography"><p>The target recipient.</p>
|
|
27
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:223</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="replytomessageid"><code class="tsd-tag">Optional</code><span>reply<wbr/>To<wbr/>Message<wbr/>Id</span><a href="#replytomessageid" 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">replyToMessageId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>(Optional) Required for replying to messages. The message
|
|
24
28
|
identifier that the new message will be associated with when creating quoted message replies.
|
|
25
29
|
This should be set to the message identifier of the message being replied to.</p>
|
|
26
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
30
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:233</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="servermessageduration"><code class="tsd-tag">Optional</code><span>server<wbr/>Message<wbr/>Duration</span><a href="#servermessageduration" 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">serverMessageDuration</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>(Optional) The absolute duration this message should exist
|
|
27
31
|
server side before self-destructing.</p>
|
|
28
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
32
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:235</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="threadid"><code class="tsd-tag">Optional</code><span>thread<wbr/>Id</span><a href="#threadid" 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">threadId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>(Optional) Required for thread messages. The message identifier
|
|
29
33
|
that the new message will be associated with when creating or replying in a message thread.
|
|
30
34
|
This should be set to the message identifier of the original message of a thread.</p>
|
|
31
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
32
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
33
|
-
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:
|
|
35
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:232</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="thumbnail"><code class="tsd-tag">Optional</code><span>thumbnail</span><a href="#thumbnail" 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">thumbnail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ArrayBuffer</span></div><div class="tsd-comment tsd-typography"><p>(Optional) The file containing the thumbnail.</p>
|
|
36
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:230</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="thumbnailinfo"><code class="tsd-tag">Optional</code><span>thumbnail<wbr/>Info</span><a href="#thumbnailinfo" 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">thumbnailInfo</span><span class="tsd-signature-symbol">?:</span> <a href="ThumbnailInfo.html" class="tsd-signature-type tsd-kind-interface">ThumbnailInfo</a></div><div class="tsd-comment tsd-typography"><p>(Optional) The thumbnail image information.</p>
|
|
37
|
+
</div><aside class="tsd-sources"><ul><li>Defined in src/public/modules/messagingModule.ts:231</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="#caption"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>caption</span></a><a href="#clientmessageduration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Message<wbr/>Duration</span></a><a href="#file"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file</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>file<wbr/>Name</span></a><a href="#filesize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Size</span></a><a href="#filetype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Type</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="#mentions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mentions</span></a><a href="#recipient"><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="#replytomessageid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reply<wbr/>To<wbr/>Message<wbr/>Id</span></a><a href="#servermessageduration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Message<wbr/>Duration</span></a><a href="#threadid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>thread<wbr/>Id</span></a><a href="#thumbnail"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>thumbnail</span></a><a href="#thumbnailinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>thumbnail<wbr/>Info</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>
|