@sudoplatform/sudo-secure-communications 5.1.1 → 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/channels/transformer/channelPowerLevelsTransformer.js +4 -7
- package/cjs/private/data/channels/transformer/channelPowerLevelsTransformer.js.map +1 -1
- package/cjs/private/data/common/apiClient.js +20 -34
- package/cjs/private/data/common/apiClient.js.map +1 -1
- package/cjs/private/data/common/matrixClientManager.js +86 -24
- package/cjs/private/data/common/matrixClientManager.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/cjs/public/modules/messagingModule.js +3 -3
- package/cjs/public/modules/messagingModule.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 +9 -0
- package/docs/interfaces/EventListenerReaction.html +11 -0
- 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/channels/transformer/channelPowerLevelsTransformer.js +4 -7
- package/lib/private/data/channels/transformer/channelPowerLevelsTransformer.js.map +1 -1
- package/lib/private/data/common/apiClient.js +21 -35
- package/lib/private/data/common/apiClient.js.map +1 -1
- package/lib/private/data/common/matrixClientManager.js +86 -24
- package/lib/private/data/common/matrixClientManager.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/lib/public/modules/messagingModule.js +3 -3
- package/lib/public/modules/messagingModule.js.map +1 -1
- package/package.json +28 -31
- package/types/private/data/common/apiClient.d.ts +1 -0
- package/types/private/data/common/matrixClientManager.d.ts +2 -3
- package/types/private/data/common/transformer/errorTransformer.d.ts +6 -2
- package/types/public/errors.d.ts +4 -1
- package/types/public/modules/messagingModule.d.ts +31 -3
- package/docs/classes/InvalidHandleError.html +0 -33
|
@@ -1,60 +1,60 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
</div
|
|
3
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
6
|
-
<a href="
|
|
7
|
-
<a href="
|
|
8
|
-
<a href="
|
|
9
|
-
<a href="
|
|
10
|
-
<a href="
|
|
11
|
-
<a href="
|
|
12
|
-
<a href="
|
|
13
|
-
<a href="
|
|
14
|
-
<a href="
|
|
15
|
-
<a href="
|
|
16
|
-
<a href="
|
|
17
|
-
<a href="
|
|
18
|
-
<a href="
|
|
19
|
-
<a href="
|
|
20
|
-
<a href="
|
|
21
|
-
<a href="
|
|
22
|
-
<a href="
|
|
23
|
-
<a href="
|
|
24
|
-
<a href="
|
|
25
|
-
<a href="
|
|
26
|
-
<a href="
|
|
27
|
-
<a href="
|
|
28
|
-
<a href="
|
|
29
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><
|
|
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>DefaultChannelsModule | @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">DefaultChannelsModule</a></li></ul><h1>Class DefaultChannelsModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Channel management for the Secure Communications Service.</p>
|
|
2
|
+
</div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/ChannelsModule.html" class="tsd-signature-type tsd-kind-interface">ChannelsModule</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/public/modules/channelsModule.ts:650</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#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>
|
|
4
|
+
<a href="#acceptinvitationrequest" 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<wbr/>Request</span></a>
|
|
5
|
+
<a href="#banhandle" 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>ban<wbr/>Handle</span></a>
|
|
6
|
+
<a href="#createchannel" 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/>Channel</span></a>
|
|
7
|
+
<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>
|
|
8
|
+
<a href="#declineinvitationrequest" 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<wbr/>Request</span></a>
|
|
9
|
+
<a href="#deletechannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Channel</span></a>
|
|
10
|
+
<a href="#getchannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel</span></a>
|
|
11
|
+
<a href="#getchannelmembers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel<wbr/>Members</span></a>
|
|
12
|
+
<a href="#getchannelmembership" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel<wbr/>Membership</span></a>
|
|
13
|
+
<a href="#getchannels" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channels</span></a>
|
|
14
|
+
<a href="#joinchannel" 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>join<wbr/>Channel</span></a>
|
|
15
|
+
<a href="#kickhandle" 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>kick<wbr/>Handle</span></a>
|
|
16
|
+
<a href="#leavechannel" 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>leave<wbr/>Channel</span></a>
|
|
17
|
+
<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>
|
|
18
|
+
<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>
|
|
19
|
+
<a href="#listreceivedinvitationrequests" 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/>Received<wbr/>Invitation<wbr/>Requests</span></a>
|
|
20
|
+
<a href="#listsentinvitationrequests" 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/>Sent<wbr/>Invitation<wbr/>Requests</span></a>
|
|
21
|
+
<a href="#searchpublicchannels" 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>search<wbr/>Public<wbr/>Channels</span></a>
|
|
22
|
+
<a href="#sendinvitationrequest" 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>send<wbr/>Invitation<wbr/>Request</span></a>
|
|
23
|
+
<a href="#sendinvitations" 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>send<wbr/>Invitations</span></a>
|
|
24
|
+
<a href="#unbanhandle" 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>unban<wbr/>Handle</span></a>
|
|
25
|
+
<a href="#updatechannel" 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>update<wbr/>Channel</span></a>
|
|
26
|
+
<a href="#updatechannelmemberrole" 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>update<wbr/>Channel<wbr/>Member<wbr/>Role</span></a>
|
|
27
|
+
<a href="#withdrawinvitation" 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>withdraw<wbr/>Invitation</span></a>
|
|
28
|
+
<a href="#withdrawinvitationrequest" 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>withdraw<wbr/>Invitation<wbr/>Request</span></a>
|
|
29
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordefaultchannelsmodule"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultChannelsModule</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">apiClient</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ApiClient</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">sessionManager</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SessionManager</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">mediaCredentialManager</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaCredentialManager</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">secureCommsServiceConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">advancedSearchEnabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">homeServer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">publicMediaBucket</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">region</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">roomMediaBucket</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">serviceEndpointUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultChannelsModule</a><a href="#constructordefaultchannelsmodule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">apiClient</span>: <span class="tsd-signature-type">ApiClient</span></span></li><li><span><span class="tsd-kind-parameter">sessionManager</span>: <span class="tsd-signature-type">SessionManager</span></span></li><li><span><span class="tsd-kind-parameter">mediaCredentialManager</span>: <span class="tsd-signature-type">MediaCredentialManager</span></span></li><li><span><span class="tsd-kind-parameter">secureCommsServiceConfig</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">advancedSearchEnabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">homeServer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">publicMediaBucket</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">region</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">roomMediaBucket</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">serviceEndpointUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DefaultChannelsModule</a></h4><aside class="tsd-sources"><ul><li>Defined in src/public/modules/channelsModule.ts:655</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="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="../interfaces/AcceptChannelInvitationInput.html" class="tsd-signature-type tsd-kind-interface">AcceptChannelInvitationInput</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>Accepts an invitation to join a channel.</p>
|
|
30
30
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/AcceptChannelInvitationInput.html" class="tsd-signature-type tsd-kind-interface">AcceptChannelInvitationInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to accept an invitation to join a channel.</p>
|
|
31
|
-
</div
|
|
31
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#acceptinvitation">acceptInvitation</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:901</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="acceptinvitationrequest"><span>accept<wbr/>Invitation<wbr/>Request</span><a href="#acceptinvitationrequest" 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="acceptinvitationrequest-1"><span class="tsd-kind-call-signature">acceptInvitationRequest</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AcceptInvitationRequestInput.html" class="tsd-signature-type tsd-kind-interface">AcceptInvitationRequestInput</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="#acceptinvitationrequest-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 request to join a channel.</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="../interfaces/AcceptInvitationRequestInput.html" class="tsd-signature-type tsd-kind-interface">AcceptInvitationRequestInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to accept an invitation request to join a channel.</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#acceptinvitationrequest">acceptInvitationRequest</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:962</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="banhandle"><span>ban<wbr/>Handle</span><a href="#banhandle" 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="banhandle-1"><span class="tsd-kind-call-signature">banHandle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/BanChannelHandleInput.html" class="tsd-signature-type tsd-kind-interface">BanChannelHandleInput</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="#banhandle-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>Bans a handle from a channel. Must have a higher role than the target handle to perform this
|
|
34
34
|
action.</p>
|
|
35
35
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/BanChannelHandleInput.html" class="tsd-signature-type tsd-kind-interface">BanChannelHandleInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to ban a handle from a channel.</p>
|
|
36
|
-
</div
|
|
36
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#banhandle">banHandle</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:1080</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createchannel"><span>create<wbr/>Channel</span><a href="#createchannel" 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="createchannel-1"><span class="tsd-kind-call-signature">createChannel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CreateChannelInput.html" class="tsd-signature-type tsd-kind-interface">CreateChannelInput</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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">></span><a href="#createchannel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new channel.</p>
|
|
37
37
|
<p>Invites handles to the newly created channel if a list of handle identifiers are supplied in the input.</p>
|
|
38
38
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/CreateChannelInput.html" class="tsd-signature-type tsd-kind-interface">CreateChannelInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters with the initial fields state for the new channel.</p>
|
|
39
|
-
</div
|
|
40
|
-
<
|
|
39
|
+
</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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">></span></h4><p>The newly created channel.</p>
|
|
40
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#createchannel">createChannel</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:668</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="../interfaces/DeclineChannelInvitationInput.html" class="tsd-signature-type tsd-kind-interface">DeclineChannelInvitationInput</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 channel.</p>
|
|
41
41
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/DeclineChannelInvitationInput.html" class="tsd-signature-type tsd-kind-interface">DeclineChannelInvitationInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to decline an invitation to join a channel.</p>
|
|
42
|
-
</div
|
|
42
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#declineinvitation">declineInvitation</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:912</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="declineinvitationrequest"><span>decline<wbr/>Invitation<wbr/>Request</span><a href="#declineinvitationrequest" 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="declineinvitationrequest-1"><span class="tsd-kind-call-signature">declineInvitationRequest</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DeclineInvitationRequestInput.html" class="tsd-signature-type tsd-kind-interface">DeclineInvitationRequestInput</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="#declineinvitationrequest-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 invitaton request to join a channel. Must have a higher role than the target handle
|
|
43
43
|
to perform this action.</p>
|
|
44
44
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/DeclineInvitationRequestInput.html" class="tsd-signature-type tsd-kind-interface">DeclineInvitationRequestInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to decline an invitation request to join a channel.</p>
|
|
45
|
-
</div
|
|
45
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#declineinvitationrequest">declineInvitationRequest</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:975</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletechannel"><span>delete<wbr/>Channel</span><a href="#deletechannel" 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="deletechannel-1"><span class="tsd-kind-call-signature">deleteChannel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DeleteChannelInput.html" class="tsd-signature-type tsd-kind-interface">DeleteChannelInput</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="#deletechannel-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>Delete an existing channel.</p>
|
|
46
46
|
<p><strong>Note:</strong> The channel needs to be private before deleting due to technical constraints.</p>
|
|
47
47
|
<p><strong>Note:</strong> The handle has to have a higher power level than everyone else in the channel in order to delete
|
|
48
48
|
it for others. This usually means that only the host of a channel can delete it.</p>
|
|
49
49
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/DeleteChannelInput.html" class="tsd-signature-type tsd-kind-interface">DeleteChannelInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to delete an existing channel.</p>
|
|
50
|
-
</div
|
|
50
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#deletechannel">deleteChannel</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:768</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getchannel"><span>get<wbr/>Channel</span><a href="#getchannel" 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="getchannel-1"><span class="tsd-kind-call-signature">getChannel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GetChannelInput.html" class="tsd-signature-type tsd-kind-interface">GetChannelInput</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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span><a href="#getchannel-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>Retrieve an individual channel by the channel's identifier.</p>
|
|
51
51
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/GetChannelInput.html" class="tsd-signature-type tsd-kind-interface">GetChannelInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to retrieve a channel.</p>
|
|
52
|
-
</div
|
|
53
|
-
<
|
|
52
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4><p>The channel matching the input identifier, or undefined if not found.</p>
|
|
53
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#getchannel">getChannel</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:779</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getchannelmembers"><span>get<wbr/>Channel<wbr/>Members</span><a href="#getchannelmembers" 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="getchannelmembers-1"><span class="tsd-kind-call-signature">getChannelMembers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GetChannelMembersInput.html" class="tsd-signature-type tsd-kind-interface">GetChannelMembersInput</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="../interfaces/ChannelMember.html" class="tsd-signature-type tsd-kind-interface">ChannelMember</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getchannelmembers-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 members of a channel that the current handle is a member of.</p>
|
|
54
54
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/GetChannelMembersInput.html" class="tsd-signature-type tsd-kind-interface">GetChannelMembersInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to retrieve a list of all channel members
|
|
55
55
|
of a channel.</p>
|
|
56
|
-
</div
|
|
57
|
-
<
|
|
56
|
+
</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="../interfaces/ChannelMember.html" class="tsd-signature-type tsd-kind-interface">ChannelMember</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The list of channel members in the channel.</p>
|
|
57
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#getchannelmembers">getChannelMembers</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:1021</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getchannelmembership"><span>get<wbr/>Channel<wbr/>Membership</span><a href="#getchannelmembership" 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="getchannelmembership-1"><span class="tsd-kind-call-signature">getChannelMembership</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GetChannelMembershipInput.html" class="tsd-signature-type tsd-kind-interface">GetChannelMembershipInput</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../enums/MembershipState.html" class="tsd-signature-type tsd-kind-enum">MembershipState</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span><a href="#getchannelmembership-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the state of membership of the current handle in the channel.</p>
|
|
58
58
|
<p><strong>Note:</strong> When a handle is not actively in the channel (status is either <a href="../enums/MembershipState.html#left" class="tsd-kind-enum-member">MembershipState.LEFT</a> or
|
|
59
59
|
<a href="../enums/MembershipState.html#banned" class="tsd-kind-enum-member">MembershipState.BANNED</a>), they will not receive membership state updates. This means the handle
|
|
60
60
|
cannot observe transitions between <a href="../enums/MembershipState.html#left" class="tsd-kind-enum-member">MembershipState.LEFT</a> and <a href="../enums/MembershipState.html#banned" class="tsd-kind-enum-member">MembershipState.BANNED</a> states.
|
|
@@ -62,54 +62,54 @@ For consistent state management, it's recommended to treat both these states as
|
|
|
62
62
|
distinguishing between them.</p>
|
|
63
63
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/GetChannelMembershipInput.html" class="tsd-signature-type tsd-kind-interface">GetChannelMembershipInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to retrieve the membership of the current handle
|
|
64
64
|
in the channel.</p>
|
|
65
|
-
</div
|
|
65
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../enums/MembershipState.html" class="tsd-signature-type tsd-kind-enum">MembershipState</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4><p>The membership state of the handle in the channel, or undefined if unknown.
|
|
66
66
|
Undefined usually means the handle has never intereacted with the channel which is equivalent to
|
|
67
67
|
<a href="../enums/MembershipState.html#left" class="tsd-kind-enum-member">MembershipState.LEFT</a>.</p>
|
|
68
|
-
<
|
|
68
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#getchannelmembership">getChannelMembership</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:1036</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getchannels"><span>get<wbr/>Channels</span><a href="#getchannels" 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="getchannels-1"><span class="tsd-kind-call-signature">getChannels</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GetChannelsInput.html" class="tsd-signature-type tsd-kind-interface">GetChannelsInput</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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getchannels-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>Batch retrieve channels with a list of channel identifiers.</p>
|
|
69
69
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/GetChannelsInput.html" class="tsd-signature-type tsd-kind-interface">GetChannelsInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to retrieve a list of channels.</p>
|
|
70
|
-
</div
|
|
70
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>List of channels matching the supplied identifiers, less any identifiers
|
|
71
71
|
that did not correspond to a channel.</p>
|
|
72
|
-
<
|
|
72
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#getchannels">getChannels</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:795</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="joinchannel"><span>join<wbr/>Channel</span><a href="#joinchannel" 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="joinchannel-1"><span class="tsd-kind-call-signature">joinChannel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/JoinChannelInput.html" class="tsd-signature-type tsd-kind-interface">JoinChannelInput</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="#joinchannel-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>Add this handle to an existing channel by identifier. Only public channels can be joined without
|
|
73
73
|
an invitation.</p>
|
|
74
74
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/JoinChannelInput.html" class="tsd-signature-type tsd-kind-interface">JoinChannelInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to add a handle to a channel.</p>
|
|
75
|
-
</div
|
|
75
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#joinchannel">joinChannel</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:840</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="kickhandle"><span>kick<wbr/>Handle</span><a href="#kickhandle" 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="kickhandle-1"><span class="tsd-kind-call-signature">kickHandle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/KickChannelHandleInput.html" class="tsd-signature-type tsd-kind-interface">KickChannelHandleInput</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="#kickhandle-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>Kicks a handle from a channel. Must have a higher role than the target handle to perform this
|
|
76
76
|
action. Can kick yourself.</p>
|
|
77
77
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/KickChannelHandleInput.html" class="tsd-signature-type tsd-kind-interface">KickChannelHandleInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to kick a handle from a channel.</p>
|
|
78
|
-
</div
|
|
78
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#kickhandle">kickHandle</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:1067</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="leavechannel"><span>leave<wbr/>Channel</span><a href="#leavechannel" 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="leavechannel-1"><span class="tsd-kind-call-signature">leaveChannel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/LeaveChannelInput.html" class="tsd-signature-type tsd-kind-interface">LeaveChannelInput</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="#leavechannel-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>Remove this handle from a specified channel by identifier.</p>
|
|
79
79
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/LeaveChannelInput.html" class="tsd-signature-type tsd-kind-interface">LeaveChannelInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to remove a handle from a channel.</p>
|
|
80
|
-
</div
|
|
80
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#leavechannel">leaveChannel</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:851</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="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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</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>Retrieve a list of all channels the handle has an active invitation for.</p>
|
|
81
81
|
</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="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>
|
|
82
|
-
</div
|
|
83
|
-
<
|
|
82
|
+
</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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A list of channels this handle has been invited to.</p>
|
|
83
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#listinvitations">listInvitations</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:923</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="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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</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>Retrieve a list of all channels the handle is included in as a member.</p>
|
|
84
84
|
</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="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>
|
|
85
|
-
</div
|
|
86
|
-
<
|
|
85
|
+
</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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A list of channels containing all of the handle's joined channels.</p>
|
|
86
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#listjoined">listJoined</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:862</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listreceivedinvitationrequests"><span>list<wbr/>Received<wbr/>Invitation<wbr/>Requests</span><a href="#listreceivedinvitationrequests" 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="listreceivedinvitationrequests-1"><span class="tsd-kind-call-signature">listReceivedInvitationRequests</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ListReceivedInvitationRequestsInput.html" class="tsd-signature-type tsd-kind-interface">ListReceivedInvitationRequestsInput</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ChannelInvitationRequest.html" class="tsd-signature-type tsd-kind-interface">ChannelInvitationRequest</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listreceivedinvitationrequests-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>Retrieve all channel invitation requests received by a specific channel.</p>
|
|
87
87
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/ListReceivedInvitationRequestsInput.html" class="tsd-signature-type tsd-kind-interface">ListReceivedInvitationRequestsInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to query for a list of received invitation requests.</p>
|
|
88
|
-
</div
|
|
89
|
-
<
|
|
88
|
+
</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="../interfaces/ChannelInvitationRequest.html" class="tsd-signature-type tsd-kind-interface">ChannelInvitationRequest</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A list of channel invitation requests for the specified channel.</p>
|
|
89
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#listreceivedinvitationrequests">listReceivedInvitationRequests</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:1002</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listsentinvitationrequests"><span>list<wbr/>Sent<wbr/>Invitation<wbr/>Requests</span><a href="#listsentinvitationrequests" 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="listsentinvitationrequests-1"><span class="tsd-kind-call-signature">listSentInvitationRequests</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handleId</span><span class="tsd-signature-symbol">:</span> <a href="HandleId.html" class="tsd-signature-type tsd-kind-class">HandleId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listsentinvitationrequests-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>Retrieve all channels this handle has sent an invitation request for.</p>
|
|
90
90
|
</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="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>
|
|
91
|
-
</div
|
|
92
|
-
<
|
|
91
|
+
</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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A list of channels the handle has requested an invite to.</p>
|
|
92
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#listsentinvitationrequests">listSentInvitationRequests</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:989</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="searchpublicchannels"><span>search<wbr/>Public<wbr/>Channels</span><a href="#searchpublicchannels" 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="searchpublicchannels-1"><span class="tsd-kind-call-signature">searchPublicChannels</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/PublicChannelSearchInput.html" class="tsd-signature-type tsd-kind-interface">PublicChannelSearchInput</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ListOutput</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PublicChannelSearchResult.html" class="tsd-signature-type tsd-kind-interface">PublicChannelSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#searchpublicchannels-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>Search existing channels that have fields matching the supplied inputs. Only public channels are searchable.</p>
|
|
93
93
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/PublicChannelSearchInput.html" class="tsd-signature-type tsd-kind-interface">PublicChannelSearchInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to search for public channels.</p>
|
|
94
|
-
</div
|
|
94
|
+
</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">ListOutput</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PublicChannelSearchResult.html" class="tsd-signature-type tsd-kind-interface">PublicChannelSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>A list of all public channel search results matching the
|
|
95
95
|
search criteria.</p>
|
|
96
|
-
<
|
|
96
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#searchpublicchannels">searchPublicChannels</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:811</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sendinvitationrequest"><span>send<wbr/>Invitation<wbr/>Request</span><a href="#sendinvitationrequest" 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="sendinvitationrequest-1"><span class="tsd-kind-call-signature">sendInvitationRequest</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SendInvitationRequestInput.html" class="tsd-signature-type tsd-kind-interface">SendInvitationRequestInput</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="#sendinvitationrequest-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>Send an invitation request to join a channel.</p>
|
|
97
97
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/SendInvitationRequestInput.html" class="tsd-signature-type tsd-kind-interface">SendInvitationRequestInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to send an invitation request to join a channel.</p>
|
|
98
|
-
</div
|
|
98
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#sendinvitationrequest">sendInvitationRequest</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:936</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sendinvitations"><span>send<wbr/>Invitations</span><a href="#sendinvitations" 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="sendinvitations-1"><span class="tsd-kind-call-signature">sendInvitations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SendChannelInvitationsInput.html" class="tsd-signature-type tsd-kind-interface">SendChannelInvitationsInput</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="#sendinvitations-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>Invite handles to join an existing channel.</p>
|
|
99
99
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/SendChannelInvitationsInput.html" class="tsd-signature-type tsd-kind-interface">SendChannelInvitationsInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to invite handles to join a channel.</p>
|
|
100
|
-
</div
|
|
100
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#sendinvitations">sendInvitations</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:875</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="unbanhandle"><span>unban<wbr/>Handle</span><a href="#unbanhandle" 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="unbanhandle-1"><span class="tsd-kind-call-signature">unbanHandle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/UnbanChannelHandleInput.html" class="tsd-signature-type tsd-kind-interface">UnbanChannelHandleInput</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="#unbanhandle-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>Unbans a handle from a channel. Must have a higher role than the target handle to perform this
|
|
101
101
|
action.</p>
|
|
102
102
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/UnbanChannelHandleInput.html" class="tsd-signature-type tsd-kind-interface">UnbanChannelHandleInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to unban a handle from a channel.</p>
|
|
103
|
-
</div
|
|
103
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#unbanhandle">unbanHandle</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:1093</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatechannel"><span>update<wbr/>Channel</span><a href="#updatechannel" 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="updatechannel-1"><span class="tsd-kind-call-signature">updateChannel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/UpdateChannelInput.html" class="tsd-signature-type tsd-kind-interface">UpdateChannelInput</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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">></span><a href="#updatechannel-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>Update the editable fields of a channel.</p>
|
|
104
104
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/UpdateChannelInput.html" class="tsd-signature-type tsd-kind-interface">UpdateChannelInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters defining the changed settings of a channel.</p>
|
|
105
|
-
</div
|
|
106
|
-
<
|
|
105
|
+
</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="../interfaces/Channel.html" class="tsd-signature-type tsd-kind-interface">Channel</a><span class="tsd-signature-symbol">></span></h4><p>The updated channel.</p>
|
|
106
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#updatechannel">updateChannel</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:722</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatechannelmemberrole"><span>update<wbr/>Channel<wbr/>Member<wbr/>Role</span><a href="#updatechannelmemberrole" 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="updatechannelmemberrole-1"><span class="tsd-kind-call-signature">updateChannelMemberRole</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/UpdateChannelMemberRoleInput.html" class="tsd-signature-type tsd-kind-interface">UpdateChannelMemberRoleInput</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="#updatechannelmemberrole-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>Updates the channel role for a specific member of a channel. Must have a higher role than the target
|
|
107
107
|
handle to perform this action. Can downgrade your own role.</p>
|
|
108
108
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/UpdateChannelMemberRoleInput.html" class="tsd-signature-type tsd-kind-interface">UpdateChannelMemberRoleInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to update the channel role of a member
|
|
109
109
|
in the channel.</p>
|
|
110
|
-
</div
|
|
110
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#updatechannelmemberrole">updateChannelMemberRole</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:1051</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withdrawinvitation"><span>withdraw<wbr/>Invitation</span><a href="#withdrawinvitation" 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="withdrawinvitation-1"><span class="tsd-kind-call-signature">withdrawInvitation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WithdrawChannelInvitationInput.html" class="tsd-signature-type tsd-kind-interface">WithdrawChannelInvitationInput</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="#withdrawinvitation-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>Withdraw a previously sent channel invitation. Must have a higher role than the target handle
|
|
111
111
|
to perform this action.</p>
|
|
112
112
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/WithdrawChannelInvitationInput.html" class="tsd-signature-type tsd-kind-interface">WithdrawChannelInvitationInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to withdraw a channel invitation.</p>
|
|
113
|
-
</div
|
|
113
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#withdrawinvitation">withdrawInvitation</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:887</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withdrawinvitationrequest"><span>withdraw<wbr/>Invitation<wbr/>Request</span><a href="#withdrawinvitationrequest" 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="withdrawinvitationrequest-1"><span class="tsd-kind-call-signature">withdrawInvitationRequest</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WithdrawInvitationRequestInput.html" class="tsd-signature-type tsd-kind-interface">WithdrawInvitationRequestInput</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="#withdrawinvitationrequest-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>Withdraw a previously sent channel invitation request.</p>
|
|
114
114
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/WithdrawInvitationRequestInput.html" class="tsd-signature-type tsd-kind-interface">WithdrawInvitationRequestInput</a></span><div class="tsd-comment tsd-typography"><p>Parameters used to withdraw an invitation request to join a channel.</p>
|
|
115
|
-
</div
|
|
115
|
+
</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"><p>Implementation of <a href="../interfaces/ChannelsModule.html">ChannelsModule</a>.<a href="../interfaces/ChannelsModule.html#withdrawinvitationrequest">withdrawInvitationRequest</a></p><ul><li>Defined in src/public/modules/channelsModule.ts:950</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#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="#acceptinvitationrequest"><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<wbr/>Request</span></a><a href="#banhandle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ban<wbr/>Handle</span></a><a href="#createchannel"><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/>Channel</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="#declineinvitationrequest"><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<wbr/>Request</span></a><a href="#deletechannel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Channel</span></a><a href="#getchannel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel</span></a><a href="#getchannelmembers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel<wbr/>Members</span></a><a href="#getchannelmembership"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel<wbr/>Membership</span></a><a href="#getchannels"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channels</span></a><a href="#joinchannel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>join<wbr/>Channel</span></a><a href="#kickhandle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>kick<wbr/>Handle</span></a><a href="#leavechannel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Channel</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="#listreceivedinvitationrequests"><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/>Received<wbr/>Invitation<wbr/>Requests</span></a><a href="#listsentinvitationrequests"><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/>Sent<wbr/>Invitation<wbr/>Requests</span></a><a href="#searchpublicchannels"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search<wbr/>Public<wbr/>Channels</span></a><a href="#sendinvitationrequest"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Invitation<wbr/>Request</span></a><a href="#sendinvitations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Invitations</span></a><a href="#unbanhandle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unban<wbr/>Handle</span></a><a href="#updatechannel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Channel</span></a><a href="#updatechannelmemberrole"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Channel<wbr/>Member<wbr/>Role</span></a><a href="#withdrawinvitation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>withdraw<wbr/>Invitation</span></a><a href="#withdrawinvitationrequest"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>withdraw<wbr/>Invitation<wbr/>Request</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>
|