@flashphoner/sfusdk 2.0.294 → 2.0.299
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/dist/client.version +1 -1
- package/dist/sdk/connection.d.ts +1 -0
- package/dist/sdk/connection.js +12 -3
- package/dist/sdk/connection.js.map +1 -1
- package/dist/sdk/constants.d.ts +15 -2
- package/dist/sdk/constants.js +9 -1
- package/dist/sdk/constants.js.map +1 -1
- package/dist/sdk/sfu-extended.d.ts +16 -1
- package/dist/sdk/sfu-extended.js +35 -1
- package/dist/sdk/sfu-extended.js.map +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/connection.Connection.html +2 -1
- package/docs/classes/sfu_extended.SfuExtended.html +88 -81
- package/docs/enums/constants.AttachmentState.html +2 -2
- package/docs/enums/constants.AuthenticationStatus.html +2 -2
- package/docs/enums/constants.ChannelSendPolicy.html +2 -2
- package/docs/enums/constants.ChatError.html +2 -2
- package/docs/enums/constants.ChatReceivePolicy.html +2 -2
- package/docs/enums/constants.ChatSectionsError.html +2 -2
- package/docs/enums/constants.ChatType.html +2 -2
- package/docs/enums/constants.ConferenceType.html +2 -2
- package/docs/enums/constants.ConnectionError.html +3 -0
- package/docs/enums/constants.ConnectionType.html +2 -2
- package/docs/enums/constants.ContactError.html +2 -2
- package/docs/enums/constants.DeliveryStatus.html +2 -2
- package/docs/enums/constants.ExamplesError.html +2 -2
- package/docs/enums/constants.ExamplesEvent.html +2 -2
- package/docs/enums/constants.InternalApi.html +3 -2
- package/docs/enums/constants.MeetingSyncEvent.html +10 -10
- package/docs/enums/constants.MessageAttachmentMediaType.html +2 -2
- package/docs/enums/constants.MessageAttachmentType.html +2 -2
- package/docs/enums/constants.MessageState.html +2 -2
- package/docs/enums/constants.MessageTargetEntityType.html +2 -2
- package/docs/enums/constants.Operations.html +2 -2
- package/docs/enums/constants.ParticipantRole.html +2 -2
- package/docs/enums/constants.PresenceStatus.html +2 -2
- package/docs/enums/constants.RemoteSdpType.html +2 -2
- package/docs/enums/constants.RoomError.html +2 -2
- package/docs/enums/constants.RoomState.html +2 -2
- package/docs/enums/constants.SortOrder.html +2 -2
- package/docs/enums/constants.SpaceError.html +2 -2
- package/docs/enums/constants.SpaceEvent.html +3 -1
- package/docs/enums/constants.State.html +2 -2
- package/docs/enums/constants.StatsType.html +2 -2
- package/docs/enums/constants.TrackType.html +2 -2
- package/docs/enums/constants.UserInfoError.html +2 -2
- package/docs/enums/constants.UserManagementError.html +2 -2
- package/docs/modules/constants.html +2 -0
- package/docs/types/constants.AddRemoveTracks.html +1 -1
- package/docs/types/constants.AddRemoveTracksSync.html +1 -1
- package/docs/types/constants.AddedMembersToThread.html +1 -1
- package/docs/types/constants.AddedRemovedReactionOnMessage.html +1 -1
- package/docs/types/constants.AddedRoleToMember.html +1 -1
- package/docs/types/constants.Attachment.html +1 -1
- package/docs/types/constants.AttachmentInfo.html +1 -1
- package/docs/types/constants.AttachmentRequest.html +1 -1
- package/docs/types/constants.AttachmentRequestAck.html +1 -1
- package/docs/types/constants.AttachmentStatus.html +1 -1
- package/docs/types/constants.AttachmentStatusEvent.html +1 -1
- package/docs/types/constants.AuthenticationStatusEvent.html +1 -1
- package/docs/types/constants.BannedContact.html +1 -1
- package/docs/types/constants.BitrateTestStatus.html +1 -1
- package/docs/types/constants.BooleanEvent.html +1 -1
- package/docs/types/constants.Calendar.html +1 -1
- package/docs/types/constants.CalendarEvent.html +1 -1
- package/docs/types/constants.CalendarEventEvent.html +1 -1
- package/docs/types/constants.Chat.html +1 -1
- package/docs/types/constants.ChatLoadedEvent.html +1 -1
- package/docs/types/constants.ChatMap.html +1 -1
- package/docs/types/constants.ChatMessagesCount.html +1 -1
- package/docs/types/constants.ChatMessagesEvent.html +1 -1
- package/docs/types/constants.ChatSearchResultEvent.html +1 -1
- package/docs/types/constants.ChatsEvent.html +1 -1
- package/docs/types/constants.ConnectionDetails.html +1 -1
- package/docs/types/constants.ConnectionFailedEvent.html +1 -1
- package/docs/types/constants.Contact.html +1 -1
- package/docs/types/constants.ContactDeleted.html +1 -1
- package/docs/types/constants.ContactUpdated.html +1 -1
- package/docs/types/constants.ControlMessage.html +1 -1
- package/docs/types/constants.ControlMessageEvent.html +1 -1
- package/docs/types/constants.CreatedRoom.html +1 -1
- package/docs/types/constants.EvictedFromRoom.html +1 -1
- package/docs/types/constants.EvictedSync.html +1 -1
- package/docs/types/constants.ExamplesUser.html +1 -1
- package/docs/types/constants.ExamplesUserEvent.html +1 -1
- package/docs/types/constants.FirstAndLastChatMessage.html +1 -1
- package/docs/types/constants.FragmentedMessage.html +1 -1
- package/docs/types/constants.FriendInvite.html +1 -1
- package/docs/types/constants.FriendInviteDeleted.html +1 -1
- package/docs/types/constants.InternalMessage.html +1 -1
- package/docs/types/constants.JoinedRoom.html +1 -1
- package/docs/types/constants.JoinedRoomSync.html +1 -1
- package/docs/types/constants.LastReadMessageUpdate.html +1 -1
- package/docs/types/constants.LastReadMessageUpdated.html +1 -1
- package/docs/types/constants.LeftMeetingSync.html +1 -1
- package/docs/types/constants.LeftRoom.html +1 -1
- package/docs/types/constants.LoadMessagesWithMentionsResult.html +1 -1
- package/docs/types/constants.MeetingEndedSync.html +1 -1
- package/docs/types/constants.MeetingNameUpdatedSync.html +1 -1
- package/docs/types/constants.MeetingsPreviewEvent.html +1 -1
- package/docs/types/constants.Message.html +1 -1
- package/docs/types/constants.MessageAttachment.html +1 -1
- package/docs/types/constants.MessageAttachmentData.html +1 -1
- package/docs/types/constants.MessageAttachmentsSearchResult.html +1 -1
- package/docs/types/constants.MessageDeleted.html +1 -1
- package/docs/types/constants.MessageDeliveryStatus.html +1 -1
- package/docs/types/constants.MessageEdited.html +1 -1
- package/docs/types/constants.MessageInfo.html +1 -1
- package/docs/types/constants.MessageReaction.html +1 -1
- package/docs/types/constants.MessageStatus.html +1 -1
- package/docs/types/constants.MessageStatusEvent.html +1 -1
- package/docs/types/constants.MessageStatusUpdate.html +1 -1
- package/docs/types/constants.MessageTargetEntityId.html +1 -1
- package/docs/types/constants.MessageWithUploadingAttachments.html +1 -1
- package/docs/types/constants.NewChatEvent.html +1 -1
- package/docs/types/constants.NewContact.html +1 -1
- package/docs/types/constants.NewFriendInvite.html +1 -1
- package/docs/types/constants.NewMeeting.html +1 -1
- package/docs/types/constants.NewSpaceCategoryEvent.html +1 -1
- package/docs/types/constants.NewSpaceChannelEvent.html +1 -1
- package/docs/types/constants.NewSpaceEvent.html +1 -1
- package/docs/types/constants.NewSpaceRoleAdded.html +1 -1
- package/docs/types/constants.NewSpaceThreadEvent.html +1 -1
- package/docs/types/constants.OperationFailed.html +1 -1
- package/docs/types/constants.OperationFailedEvent.html +1 -1
- package/docs/types/constants.Participant.html +1 -1
- package/docs/types/constants.ParticipantAVSMutedEvent.html +1 -1
- package/docs/types/constants.ParticipantConfigEvent.html +1 -1
- package/docs/types/constants.ParticipantRenamed.html +1 -1
- package/docs/types/constants.ParticipantsListEvent.html +1 -1
- package/docs/types/constants.ParticipantsListSyncEvent.html +1 -1
- package/docs/types/constants.PlacedInLobbyEvent.html +1 -1
- package/docs/types/constants.PlacedInWaitingRoomEvent.html +1 -1
- package/docs/types/constants.PublicChannelsEvent.html +1 -1
- package/docs/types/constants.Quality.html +1 -1
- package/docs/types/constants.RemoteSdp.html +1 -1
- package/docs/types/constants.RemoteSdpInfo.html +1 -1
- package/docs/types/constants.RemovedChatEvent.html +1 -1
- package/docs/types/constants.RemovedMemberFromThread.html +1 -1
- package/docs/types/constants.RemovedRoleFromMember.html +1 -1
- package/docs/types/constants.ResetPasswordRequestStatus.html +1 -1
- package/docs/types/constants.RoleAssigned.html +1 -1
- package/docs/types/constants.RolePermissionSectionsEvent.html +1 -1
- package/docs/types/constants.RolesListEvent.html +1 -1
- package/docs/types/constants.RoomAvailable.html +1 -1
- package/docs/types/constants.RoomConfigEvent.html +1 -1
- package/docs/types/constants.RoomExtendedConfig.html +1 -1
- package/docs/types/constants.RoomExtendedParticipantConfig.html +1 -1
- package/docs/types/constants.RoomExtendedParticipantsConfig.html +1 -1
- package/docs/types/constants.RoomExtendedScreenSharingConfig.html +1 -1
- package/docs/types/constants.RoomInfo.html +1 -1
- package/docs/types/constants.RoomMessage.html +1 -1
- package/docs/types/constants.RoomNameUpdated.html +1 -1
- package/docs/types/constants.RoomScreenSharingConfigEvent.html +1 -1
- package/docs/types/constants.SFUMeetingParticipantPreview.html +1 -1
- package/docs/types/constants.SFUMeetingPreview.html +1 -1
- package/docs/types/constants.SfuMessageEvent.html +1 -1
- package/docs/types/constants.SfuSpace.html +1 -1
- package/docs/types/constants.SfuSpaceCategory.html +1 -1
- package/docs/types/constants.SfuSpaceChannel.html +1 -1
- package/docs/types/constants.SfuSpaceChannelAccessRights.html +1 -1
- package/docs/types/constants.SfuSpaceInvite.html +1 -1
- package/docs/types/constants.SfuSpaceMember.html +1 -1
- package/docs/types/constants.SfuSpaceRole.html +1 -1
- package/docs/types/constants.SfuSpaceRolePermission.html +1 -1
- package/docs/types/constants.SfuSpaceRolePermissionSection.html +1 -1
- package/docs/types/constants.SfuSpaceThread.html +1 -1
- package/docs/types/constants.SfuSpaceUserBan.html +1 -1
- package/docs/types/constants.SignUpStatus.html +1 -1
- package/docs/types/constants.SpaceCategoryDeleted.html +1 -1
- package/docs/types/constants.SpaceCategoryUpdated.html +1 -1
- package/docs/types/constants.SpaceChannelDeleted.html +1 -1
- package/docs/types/constants.SpaceChannelMoved.html +1 -1
- package/docs/types/constants.SpaceChannelUpdated.html +1 -1
- package/docs/types/constants.SpaceCreatedEvent.html +1 -1
- package/docs/types/constants.SpaceDeletedEvent.html +1 -1
- package/docs/types/constants.SpaceInviteCreated.html +1 -1
- package/docs/types/constants.SpaceInviteRevoked.html +1 -1
- package/docs/types/constants.SpaceOverviewUpdated.html +1 -1
- package/docs/types/constants.SpaceRoleDeleted.html +1 -1
- package/docs/types/constants.SpaceRoleUpdated.html +1 -1
- package/docs/types/constants.SpaceThreadDeleted.html +1 -1
- package/docs/types/constants.SpaceThreadUpdated.html +1 -1
- package/docs/types/constants.StopScreenSharingEvent.html +1 -1
- package/docs/types/constants.StopTrackEvent.html +1 -1
- package/docs/types/constants.TracksQualityState.html +1 -1
- package/docs/types/constants.UnreadMessagesCountEvent.html +1 -1
- package/docs/types/constants.UnreadMessagesCountUpdate.html +1 -1
- package/docs/types/constants.UpdateChatEvent.html +1 -1
- package/docs/types/constants.UpdateMessagesDeliveryStatusEvent.html +1 -1
- package/docs/types/constants.UploadingAttachmentInfo.html +1 -1
- package/docs/types/constants.UserCalendarEvent.html +1 -1
- package/docs/types/constants.UserChatEncryptedPassword.html +1 -1
- package/docs/types/constants.UserContacts.html +1 -1
- package/docs/types/constants.UserContactsEvent.html +1 -1
- package/docs/types/constants.UserEmail.html +1 -1
- package/docs/types/constants.UserEncryptionInfo.html +1 -1
- package/docs/types/constants.UserEncryptionInfoEvent.html +1 -1
- package/docs/types/constants.UserHostKey.html +1 -1
- package/docs/types/constants.UserHostKeyChangedEvent.html +1 -1
- package/docs/types/constants.UserId.html +1 -1
- package/docs/types/constants.UserInfo.html +1 -1
- package/docs/types/constants.UserInfoChangedEvent.html +1 -1
- package/docs/types/constants.UserInfoEvent.html +1 -1
- package/docs/types/constants.UserJoinedToSpaceEvent.html +1 -1
- package/docs/types/constants.UserLeftSpace.html +1 -1
- package/docs/types/constants.UserNickname.html +1 -1
- package/docs/types/constants.UserNicknameChangedEvent.html +1 -1
- package/docs/types/constants.UserPassword.html +1 -1
- package/docs/types/constants.UserPhoneNumber.html +1 -1
- package/docs/types/constants.UserPhoneNumberChangedEvent.html +1 -1
- package/docs/types/constants.UserPmiSettings.html +1 -1
- package/docs/types/constants.UserPresenceStatusUpdated.html +1 -1
- package/docs/types/constants.UserRoomsEvent.html +1 -1
- package/docs/types/constants.UserSpaceNicknameUpdated.html +1 -0
- package/docs/types/constants.UserSpacesEvent.html +1 -1
- package/docs/types/constants.UserSpecificChatInfo.html +1 -1
- package/docs/types/constants.UserTimezone.html +1 -1
- package/docs/types/constants.UserTimezoneChangedEvent.html +1 -1
- package/docs/types/constants.WaitingListEvent.html +1 -1
- package/docs/types/constants.WaitingParticipant.html +1 -1
- package/docs/types/constants.WaitingRoomUpdate.html +1 -1
- package/docs/types/sfu_extended.EventUnion.html +1 -1
- package/docs/types/sfu_extended.NotifyUnion.html +1 -1
- package/docs/variables/constants.ATTACHMENT_CHUNK_SIZE.html +1 -1
- package/docs/variables/constants.ATTACHMENT_ID_LENGTH.html +1 -1
- package/docs/variables/constants.WS_CONNECTION_TIMEOUT.html +1 -1
- package/docs/variables/constants.WS_PINGS_MISSING_THRESHOLD.html +1 -1
- package/docs/variables/constants.WS_PING_INTERVAL_MS.html +1 -1
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SfuExtended | @flashphoner/sfusdk</title><meta name="description" content="Documentation for @flashphoner/sfusdk"/><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@flashphoner/sfusdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@flashphoner/sfusdk</a></li><li><a href="../modules/sfu_extended.html">sfu-extended</a></li><li><a href="sfu_extended.SfuExtended.html">SfuExtended</a></li></ul><h1>Class SfuExtended</h1></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SfuExtended | @flashphoner/sfusdk</title><meta name="description" content="Documentation for @flashphoner/sfusdk"/><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@flashphoner/sfusdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@flashphoner/sfusdk</a></li><li><a href="../modules/sfu_extended.html">sfu-extended</a></li><li><a href="sfu_extended.SfuExtended.html">SfuExtended</a></li></ul><h1>Class SfuExtended</h1></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:162</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="sfu_extended.SfuExtended.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
2
2
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="sfu_extended.SfuExtended.html#__server" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>server</span></a>
|
|
3
3
|
<a href="sfu_extended.SfuExtended.html#__state" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>state</span></a>
|
|
4
4
|
<a href="sfu_extended.SfuExtended.html#__url" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>url</span></a>
|
|
@@ -117,6 +117,7 @@
|
|
|
117
117
|
<a href="sfu_extended.SfuExtended.html#updatePresenceStatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Presence<wbr/>Status</span></a>
|
|
118
118
|
<a href="sfu_extended.SfuExtended.html#updateSpaceCategory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Category</span></a>
|
|
119
119
|
<a href="sfu_extended.SfuExtended.html#updateSpaceChannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Channel</span></a>
|
|
120
|
+
<a href="sfu_extended.SfuExtended.html#updateSpaceNickname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Nickname</span></a>
|
|
120
121
|
<a href="sfu_extended.SfuExtended.html#updateSpaceOverview" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Overview</span></a>
|
|
121
122
|
<a href="sfu_extended.SfuExtended.html#updateSpaceRole" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Role</span></a>
|
|
122
123
|
<a href="sfu_extended.SfuExtended.html#updateSpaceThread" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Thread</span></a>
|
|
@@ -125,14 +126,14 @@
|
|
|
125
126
|
<a href="sfu_extended.SfuExtended.html#fromUTF8ArrayToStr" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fromUTF8<wbr/>Array<wbr/>To<wbr/>Str</span></a>
|
|
126
127
|
<a href="sfu_extended.SfuExtended.html#generateAttachmentId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Attachment<wbr/>Id</span></a>
|
|
127
128
|
<a href="sfu_extended.SfuExtended.html#strToUTF8Array" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>str<wbr/>ToUTF8<wbr/>Array</span></a>
|
|
128
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_SfuExtended" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Sfu<wbr/>Extended</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">logLevel</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">prefix</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">log</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sfu_extended.SfuExtended.html" class="tsd-signature-type tsd-kind-class">SfuExtended</a><a href="#constructor.new_SfuExtended" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">logLevel</span>: <a href="../enums/logger.Verbosity.html" class="tsd-signature-type tsd-kind-enum">Verbosity</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">prefix</span>: <a href="../types/logger.PrefixFunction.html" class="tsd-signature-type tsd-kind-type-alias">PrefixFunction</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">log</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="sfu_extended.SfuExtended.html" class="tsd-signature-type tsd-kind-class">SfuExtended</a></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:184</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="__server" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#_<wbr/>server</span><a href="#__server" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#_<wbr/>server</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:170</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="__state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#_<wbr/>state</span><a href="#__state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#_<wbr/>state</span><span class="tsd-signature-symbol">:</span> <a href="../enums/constants.State.html" class="tsd-signature-type tsd-kind-enum">State</a><span class="tsd-signature-symbol"> = State.NEW</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:172</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="__url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#_<wbr/>url</span><a href="#__url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#_<wbr/>url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:171</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="__user" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#_<wbr/>user</span><a href="#__user" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#_<wbr/>user</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">auth<wbr/>Token</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:163</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_attachmentsTransferManager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#attachments<wbr/>Transfer<wbr/>Manager</span><a href="#_attachmentsTransferManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#attachments<wbr/>Transfer<wbr/>Manager</span><span class="tsd-signature-symbol">:</span> <a href="attachments_transfer_manager.AttachmentsTransferManager.html" class="tsd-signature-type tsd-kind-class">AttachmentsTransferManager</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:177</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_binaryChunkSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#binary<wbr/>Chunk<wbr/>Size</span><a href="#_binaryChunkSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#binary<wbr/>Chunk<wbr/>Size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:178</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_connection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#connection</span><a href="#_connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#connection</span><span class="tsd-signature-symbol">:</span> <a href="connection.Connection.html" class="tsd-signature-type tsd-kind-class">Connection</a></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:162</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_logger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#logger</span><a href="#_logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#logger</span><span class="tsd-signature-symbol">:</span> <a href="logger.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:179</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_loggerPrefix" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#logger<wbr/>Prefix</span><a href="#_loggerPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#logger<wbr/>Prefix</span><span class="tsd-signature-symbol">:</span> <a href="../types/logger.PrefixFunction.html" class="tsd-signature-type tsd-kind-type-alias">PrefixFunction</a></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:180</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_notifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#notifier</span><a href="#_notifier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#notifier</span><span class="tsd-signature-symbol">:</span> <a href="notifier.Notifier.html" class="tsd-signature-type tsd-kind-class">Notifier</a><span class="tsd-signature-symbol"><</span><a href="../types/sfu_extended.EventUnion.html" class="tsd-signature-type tsd-kind-type-alias">EventUnion</a><span class="tsd-signature-symbol">, </span><a href="../types/sfu_extended.NotifyUnion.html" class="tsd-signature-type tsd-kind-type-alias">NotifyUnion</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:175</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_resetPasswordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#reset<wbr/>Password<wbr/>Id</span><a href="#_resetPasswordId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#reset<wbr/>Password<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ''</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:182</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_rooms" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#rooms</span><a href="#_rooms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#rooms</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:173</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_signUpId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#sign<wbr/>Up<wbr/>Id</span><a href="#_signUpId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#sign<wbr/>Up<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ''</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:181</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_uploadingAttachmentState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#uploading<wbr/>Attachment<wbr/>State</span><a href="#_uploadingAttachmentState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#uploading<wbr/>Attachment<wbr/>State</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MessageWithUploadingAttachmentState</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:176</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="_checkAuthenticated" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#check<wbr/>Authenticated</span><a href="#_checkAuthenticated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_checkAuthenticated._checkAuthenticated-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#check<wbr/>Authenticated</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_checkAuthenticated._checkAuthenticated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:209</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_createConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#create<wbr/>Connection</span><a href="#_createConnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_createConnection._createConnection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#create<wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_createConnection._createConnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:292</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_emmitAction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#emmit<wbr/>Action</span><a href="#_emmitAction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_emmitAction._emmitAction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#emmit<wbr/>Action</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">action</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">resolve</span>, <span class="tsd-kind-parameter">reject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_emmitAction._emmitAction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">action</span>: <a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a></span></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">object</span></span></li><li><span><span class="tsd-kind-parameter">resolve</span>: <span class="tsd-signature-type">Function</span></span></li><li><span><span class="tsd-kind-parameter">reject</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:196</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_emmitBinaryAction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#emmit<wbr/>Binary<wbr/>Action</span><a href="#_emmitBinaryAction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_emmitBinaryAction._emmitBinaryAction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#emmit<wbr/>Binary<wbr/>Action</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_emmitBinaryAction._emmitBinaryAction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">data</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:205</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_getConnectionConfigForAnonymousUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Anonymous<wbr/>User</span><a href="#_getConnectionConfigForAnonymousUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_getConnectionConfigForAnonymousUser._getConnectionConfigForAnonymousUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Anonymous<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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><a href="#_getConnectionConfigForAnonymousUser._getConnectionConfigForAnonymousUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">url</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">app<wbr/>Name</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1154</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_getConnectionConfigForExamples" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Examples</span><a href="#_getConnectionConfigForExamples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_getConnectionConfigForExamples._getConnectionConfigForExamples-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Examples</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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><a href="#_getConnectionConfigForExamples._getConnectionConfigForExamples-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">url</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">app<wbr/>Name</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3162</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="acceptFriendInvite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>accept<wbr/>Friend<wbr/>Invite</span><a href="#acceptFriendInvite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="acceptFriendInvite.acceptFriendInvite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">accept<wbr/>Friend<wbr/>Invite</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">invite</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Contact.html" class="tsd-signature-type tsd-kind-type-alias">Contact</a><span class="tsd-signature-symbol">></span><a href="#acceptFriendInvite.acceptFriendInvite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Accept friend invite</p>
|
|
129
|
+
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_SfuExtended" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Sfu<wbr/>Extended</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">logLevel</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">prefix</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">log</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sfu_extended.SfuExtended.html" class="tsd-signature-type tsd-kind-class">SfuExtended</a><a href="#constructor.new_SfuExtended" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">logLevel</span>: <a href="../enums/logger.Verbosity.html" class="tsd-signature-type tsd-kind-enum">Verbosity</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">prefix</span>: <a href="../types/logger.PrefixFunction.html" class="tsd-signature-type tsd-kind-type-alias">PrefixFunction</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">log</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="sfu_extended.SfuExtended.html" class="tsd-signature-type tsd-kind-class">SfuExtended</a></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:186</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="__server" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#_<wbr/>server</span><a href="#__server" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#_<wbr/>server</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:172</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="__state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#_<wbr/>state</span><a href="#__state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#_<wbr/>state</span><span class="tsd-signature-symbol">:</span> <a href="../enums/constants.State.html" class="tsd-signature-type tsd-kind-enum">State</a><span class="tsd-signature-symbol"> = State.NEW</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:174</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="__url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#_<wbr/>url</span><a href="#__url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#_<wbr/>url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:173</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="__user" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#_<wbr/>user</span><a href="#__user" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#_<wbr/>user</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">auth<wbr/>Token</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:165</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_attachmentsTransferManager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#attachments<wbr/>Transfer<wbr/>Manager</span><a href="#_attachmentsTransferManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#attachments<wbr/>Transfer<wbr/>Manager</span><span class="tsd-signature-symbol">:</span> <a href="attachments_transfer_manager.AttachmentsTransferManager.html" class="tsd-signature-type tsd-kind-class">AttachmentsTransferManager</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:179</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_binaryChunkSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#binary<wbr/>Chunk<wbr/>Size</span><a href="#_binaryChunkSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#binary<wbr/>Chunk<wbr/>Size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:180</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_connection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#connection</span><a href="#_connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#connection</span><span class="tsd-signature-symbol">:</span> <a href="connection.Connection.html" class="tsd-signature-type tsd-kind-class">Connection</a></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:164</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_logger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#logger</span><a href="#_logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#logger</span><span class="tsd-signature-symbol">:</span> <a href="logger.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:181</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_loggerPrefix" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#logger<wbr/>Prefix</span><a href="#_loggerPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#logger<wbr/>Prefix</span><span class="tsd-signature-symbol">:</span> <a href="../types/logger.PrefixFunction.html" class="tsd-signature-type tsd-kind-type-alias">PrefixFunction</a></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:182</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_notifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#notifier</span><a href="#_notifier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#notifier</span><span class="tsd-signature-symbol">:</span> <a href="notifier.Notifier.html" class="tsd-signature-type tsd-kind-class">Notifier</a><span class="tsd-signature-symbol"><</span><a href="../types/sfu_extended.EventUnion.html" class="tsd-signature-type tsd-kind-type-alias">EventUnion</a><span class="tsd-signature-symbol">, </span><a href="../types/sfu_extended.NotifyUnion.html" class="tsd-signature-type tsd-kind-type-alias">NotifyUnion</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:177</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_resetPasswordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#reset<wbr/>Password<wbr/>Id</span><a href="#_resetPasswordId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#reset<wbr/>Password<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ''</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:184</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_rooms" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#rooms</span><a href="#_rooms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#rooms</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:175</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_signUpId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#sign<wbr/>Up<wbr/>Id</span><a href="#_signUpId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#sign<wbr/>Up<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ''</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:183</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_uploadingAttachmentState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#uploading<wbr/>Attachment<wbr/>State</span><a href="#_uploadingAttachmentState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#uploading<wbr/>Attachment<wbr/>State</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MessageWithUploadingAttachmentState</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:178</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="_checkAuthenticated" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#check<wbr/>Authenticated</span><a href="#_checkAuthenticated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_checkAuthenticated._checkAuthenticated-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#check<wbr/>Authenticated</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_checkAuthenticated._checkAuthenticated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:211</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_createConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#create<wbr/>Connection</span><a href="#_createConnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_createConnection._createConnection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#create<wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_createConnection._createConnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:302</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_emmitAction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#emmit<wbr/>Action</span><a href="#_emmitAction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_emmitAction._emmitAction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#emmit<wbr/>Action</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">action</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">resolve</span>, <span class="tsd-kind-parameter">reject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_emmitAction._emmitAction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">action</span>: <a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a></span></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">object</span></span></li><li><span><span class="tsd-kind-parameter">resolve</span>: <span class="tsd-signature-type">Function</span></span></li><li><span><span class="tsd-kind-parameter">reject</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:198</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_emmitBinaryAction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#emmit<wbr/>Binary<wbr/>Action</span><a href="#_emmitBinaryAction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_emmitBinaryAction._emmitBinaryAction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#emmit<wbr/>Binary<wbr/>Action</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_emmitBinaryAction._emmitBinaryAction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">data</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:207</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_getConnectionConfigForAnonymousUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Anonymous<wbr/>User</span><a href="#_getConnectionConfigForAnonymousUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_getConnectionConfigForAnonymousUser._getConnectionConfigForAnonymousUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Anonymous<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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><a href="#_getConnectionConfigForAnonymousUser._getConnectionConfigForAnonymousUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">url</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">app<wbr/>Name</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1169</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_getConnectionConfigForExamples" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Examples</span><a href="#_getConnectionConfigForExamples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="_getConnectionConfigForExamples._getConnectionConfigForExamples-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Examples</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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><a href="#_getConnectionConfigForExamples._getConnectionConfigForExamples-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">url</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">appName</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">app<wbr/>Name</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.InternalApi.html" class="tsd-signature-type tsd-kind-enum">InternalApi</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3203</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="acceptFriendInvite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>accept<wbr/>Friend<wbr/>Invite</span><a href="#acceptFriendInvite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="acceptFriendInvite.acceptFriendInvite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">accept<wbr/>Friend<wbr/>Invite</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">invite</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Contact.html" class="tsd-signature-type tsd-kind-type-alias">Contact</a><span class="tsd-signature-symbol">></span><a href="#acceptFriendInvite.acceptFriendInvite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Accept friend invite</p>
|
|
129
130
|
<p>Users will receive <a href="../enums/constants.SfuEvent.html#OUTGOING_FRIEND_INVITE_DELETED" class="tsd-kind-enum-member">SfuEvent.OUTGOING_FRIEND_INVITE_DELETED</a> and <a href="../enums/constants.SfuEvent.html#INCOMING_FRIEND_INVITE_DELETED" class="tsd-kind-enum-member">SfuEvent.INCOMING_FRIEND_INVITE_DELETED</a> with <a href="../types/constants.FriendInviteDeleted.html" class="tsd-kind-type-alias">FriendInviteDeleted</a> for invites.
|
|
130
131
|
Users will receive <a href="../enums/constants.SfuEvent.html#CONTACT_UPDATED" class="tsd-kind-enum-member">SfuEvent.CONTACT_UPDATED</a> with <a href="../types/constants.ContactUpdated.html" class="tsd-kind-type-alias">ContactUpdated</a> if they have mutual space channels or direct chats.
|
|
131
132
|
Will receive <a href="../enums/constants.SfuEvent.html#NEW_CONTACT" class="tsd-kind-enum-member">SfuEvent.NEW_CONTACT</a> with <a href="../types/constants.NewContact.html" class="tsd-kind-type-alias">NewContact</a> if haven't.</p>
|
|
132
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">invite</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">inviteId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">invite<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Contact.html" class="tsd-signature-type tsd-kind-type-alias">Contact</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
133
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">invite</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">inviteId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">invite<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Contact.html" class="tsd-signature-type tsd-kind-type-alias">Contact</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1737</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addCalendarEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Calendar<wbr/>Event</span><a href="#addCalendarEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addCalendarEvent.addCalendarEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Calendar<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.CalendarEvent.html" class="tsd-signature-type tsd-kind-type-alias">CalendarEvent</a><span class="tsd-signature-symbol">></span><a href="#addCalendarEvent.addCalendarEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add calendar event</p>
|
|
133
134
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">accessCode</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">allowJoinAtAnyTime</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">ownerVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">participantVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">recurring</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useLocalAutoRecord</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useMuteAudioOnJoin</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">usePMI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">waitingRoom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">access<wbr/>Code</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">allow<wbr/>Join<wbr/>At<wbr/>Any<wbr/>Time</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">owner<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">participant<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">recurring</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Local<wbr/>Auto<wbr/>Record</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Mute<wbr/>Audio<wbr/>On<wbr/>Join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">usePMI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>if true then user PMI settings will be updated and user will receive <a href="../enums/constants.SfuEvent.html#UPDATE_USER_PMI_SETTINGS" class="tsd-kind-enum-member">SfuEvent.UPDATE_USER_PMI_SETTINGS</a> with <a href="../types/constants.UserPmiSettings.html" class="tsd-kind-type-alias">UserPmiSettings</a></p>
|
|
134
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">waiting<wbr/>Room</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.CalendarEvent.html" class="tsd-signature-type tsd-kind-type-alias">CalendarEvent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
135
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
135
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">waiting<wbr/>Room</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.CalendarEvent.html" class="tsd-signature-type tsd-kind-type-alias">CalendarEvent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1783</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addChannelSendPermissionListMember" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">add<wbr/>Channel<wbr/>Send<wbr/>Permission<wbr/>List<wbr/>Member</span><a href="#addChannelSendPermissionListMember" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addChannelSendPermissionListMember.addChannelSendPermissionListMember-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Channel<wbr/>Send<wbr/>Permission<wbr/>List<wbr/>Member</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#addChannelSendPermissionListMember.addChannelSendPermissionListMember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">channel</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">member</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">member</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2336</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addChatToFavourites" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Chat<wbr/>To<wbr/>Favourites</span><a href="#addChatToFavourites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addChatToFavourites.addChatToFavourites-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Chat<wbr/>To<wbr/>Favourites</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#addChatToFavourites.addChatToFavourites-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Used to change <a href="../types/constants.UserSpecificChatInfo.html#__type.favourite" class="tsd-kind-property">UserSpecificChatInfo.favourite</a> to true</p>
|
|
136
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2387</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addFriend" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Friend</span><a href="#addFriend" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addFriend.addFriend-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Friend</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#addFriend.addFriend-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a friend</p>
|
|
136
137
|
<p>Sends a friend invite.
|
|
137
138
|
Users will receive <a href="../enums/constants.SfuEvent.html#NEW_OUTGOING_FRIEND_INVITE" class="tsd-kind-enum-member">SfuEvent.NEW_OUTGOING_FRIEND_INVITE</a> and <a href="../enums/constants.SfuEvent.html#NEW_INCOMING_FRIEND_INVITE" class="tsd-kind-enum-member">SfuEvent.NEW_INCOMING_FRIEND_INVITE</a> with <a href="../types/constants.NewFriendInvite.html" class="tsd-kind-type-alias">NewFriendInvite</a>.</p>
|
|
138
139
|
<p>If an invite was sent to this user previously, it will be replaced with a new one.
|
|
@@ -142,36 +143,36 @@ Users will receive <a href="../enums/constants.SfuEvent.html#NEW_OUTGOING_FRIEND
|
|
|
142
143
|
Users will receive <a href="../enums/constants.SfuEvent.html#OUTGOING_FRIEND_INVITE_DELETED" class="tsd-kind-enum-member">SfuEvent.OUTGOING_FRIEND_INVITE_DELETED</a> and <a href="../enums/constants.SfuEvent.html#INCOMING_FRIEND_INVITE_DELETED" class="tsd-kind-enum-member">SfuEvent.INCOMING_FRIEND_INVITE_DELETED</a> with <a href="../types/constants.FriendInviteDeleted.html" class="tsd-kind-type-alias">FriendInviteDeleted</a> for invites.
|
|
143
144
|
Users will receive <a href="../enums/constants.SfuEvent.html#CONTACT_UPDATED" class="tsd-kind-enum-member">SfuEvent.CONTACT_UPDATED</a> with <a href="../types/constants.ContactUpdated.html" class="tsd-kind-type-alias">ContactUpdated</a> if they have mutual space channels or direct chats.
|
|
144
145
|
Will receive <a href="../enums/constants.SfuEvent.html#NEW_CONTACT" class="tsd-kind-enum-member">SfuEvent.NEW_CONTACT</a> with <a href="../types/constants.NewContact.html" class="tsd-kind-type-alias">NewContact</a> if haven't.</p>
|
|
145
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">user</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">userId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">user<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
146
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">user</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">userId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">user<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1683</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addMemberToChat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Member<wbr/>To<wbr/>Chat</span><a href="#addMemberToChat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addMemberToChat.addMemberToChat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Member<wbr/>To<wbr/>Chat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#addMemberToChat.addMemberToChat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a member to chat</p>
|
|
146
147
|
<p>Chat members will receive <a href="../enums/constants.SfuEvent.html#CHAT_UPDATED" class="tsd-kind-enum-member">SfuEvent.CHAT_UPDATED</a> with <a href="../types/constants.UserSpecificChatInfo.html" class="tsd-kind-type-alias">UserSpecificChatInfo</a></p>
|
|
147
148
|
<p>If a direct meeting was started, user will receive <a href="../enums/constants.SfuEvent.html#NEW_MEETING" class="tsd-kind-enum-member">SfuEvent.NEW_MEETING</a> with <a href="../types/constants.NewMeeting.html" class="tsd-kind-type-alias">NewMeeting</a>.</p>
|
|
148
149
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">encryptedChatPassword</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">member</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">encrypted<wbr/>Chat<wbr/>Password</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>required for adding to a secure encrypted chat.
|
|
149
150
|
chat password encrypted with the member's public key, which must be decrypted using the user's private key.</p>
|
|
150
151
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">member</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>user will receive <a href="../enums/constants.SfuEvent.html#NEW_CHAT" class="tsd-kind-enum-member">SfuEvent.NEW_CHAT</a> with <a href="../types/constants.UserSpecificChatInfo.html" class="tsd-kind-type-alias">UserSpecificChatInfo</a>.</p>
|
|
151
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
152
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2265</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addMembersToThread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Members<wbr/>To<wbr/>Thread</span><a href="#addMembersToThread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addMembersToThread.addMembersToThread-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Members<wbr/>To<wbr/>Thread</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedMembersToThread.html" class="tsd-signature-type tsd-kind-type-alias">AddedMembersToThread</a><span class="tsd-signature-symbol">></span><a href="#addMembersToThread.addMembersToThread-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add members to thread</p>
|
|
152
153
|
<p>Thread members will receive <a href="../enums/constants.SpaceEvent.html#ADDED_MEMBERS_TO_THREAD" class="tsd-kind-enum-member">SpaceEvent.ADDED_MEMBERS_TO_THREAD</a> with <a href="../types/constants.AddedMembersToThread.html" class="tsd-kind-type-alias">AddedMembersToThread</a></p>
|
|
153
154
|
<p>New members will receive NEW_SPACE_THREAD with <a href="../types/constants.NewSpaceThreadEvent.html" class="tsd-kind-type-alias">NewSpaceThreadEvent</a></p>
|
|
154
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">threadId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">thread<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedMembersToThread.html" class="tsd-signature-type tsd-kind-type-alias">AddedMembersToThread</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
155
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">threadId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">thread<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedMembersToThread.html" class="tsd-signature-type tsd-kind-type-alias">AddedMembersToThread</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2940</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addReactionOnMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Reaction<wbr/>On<wbr/>Message</span><a href="#addReactionOnMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addReactionOnMessage.addReactionOnMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Reaction<wbr/>On<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedRemovedReactionOnMessage.html" class="tsd-signature-type tsd-kind-type-alias">AddedRemovedReactionOnMessage</a><span class="tsd-signature-symbol">></span><a href="#addReactionOnMessage.addReactionOnMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add reaction on message in a Direct chat | Channel | Thread</p>
|
|
155
156
|
<p>Members will receive <a href="../enums/constants.SfuEvent.html#REACTION_ON_MESSAGE_ADDED" class="tsd-kind-enum-member">SfuEvent.REACTION_ON_MESSAGE_ADDED</a> with <a href="../types/constants.AddedRemovedReactionOnMessage.html" class="tsd-kind-type-alias">AddedRemovedReactionOnMessage</a></p>
|
|
156
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">messageId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">reaction</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">message<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">reaction</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedRemovedReactionOnMessage.html" class="tsd-signature-type tsd-kind-type-alias">AddedRemovedReactionOnMessage</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
157
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">messageId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">reaction</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">message<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">reaction</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedRemovedReactionOnMessage.html" class="tsd-signature-type tsd-kind-type-alias">AddedRemovedReactionOnMessage</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1308</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addRoleToMember" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Role<wbr/>To<wbr/>Member</span><a href="#addRoleToMember" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addRoleToMember.addRoleToMember-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Role<wbr/>To<wbr/>Member</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedRoleToMember.html" class="tsd-signature-type tsd-kind-type-alias">AddedRoleToMember</a><span class="tsd-signature-symbol">></span><a href="#addRoleToMember.addRoleToMember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add space role to member</p>
|
|
157
158
|
<p>For space owner/user that has permission to manage roles</p>
|
|
158
159
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#ADDED_ROLE_TO_MEMBER" class="tsd-kind-enum-member">SpaceEvent.ADDED_ROLE_TO_MEMBER</a> with <a href="../types/constants.AddedRoleToMember.html" class="tsd-kind-type-alias">AddedRoleToMember</a></p>
|
|
159
160
|
<p>Member who are assigned this role will receive <a href="../enums/constants.SpaceEvent.html#NEW_SPACE_CHANNEL" class="tsd-kind-enum-member">SpaceEvent.NEW_SPACE_CHANNEL</a> with <a href="../types/constants.NewSpaceChannelEvent.html" class="tsd-kind-type-alias">NewSpaceChannelEvent</a> for each channel that has this role in its access rights.
|
|
160
161
|
Other members of these channels will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CHANNEL_UPDATED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CHANNEL_UPDATED</a> with <a href="../types/constants.SpaceChannelUpdated.html" class="tsd-kind-type-alias">SpaceChannelUpdated</a>.</p>
|
|
161
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">memberId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">roleId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">member<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">role<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedRoleToMember.html" class="tsd-signature-type tsd-kind-type-alias">AddedRoleToMember</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
162
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">memberId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">roleId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">member<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">role<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedRoleToMember.html" class="tsd-signature-type tsd-kind-type-alias">AddedRoleToMember</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3108</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addSpaceRole" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Space<wbr/>Role</span><a href="#addSpaceRole" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addSpaceRole.addSpaceRole-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Space<wbr/>Role</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">role</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceRole.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceRole</a><span class="tsd-signature-symbol">></span><a href="#addSpaceRole.addSpaceRole-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add space role</p>
|
|
162
163
|
<p>For space owner/user that has permission to manage roles</p>
|
|
163
164
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#NEW_SPACE_ROLE" class="tsd-kind-enum-member">SpaceEvent.NEW_SPACE_ROLE</a> with <a href="../types/constants.NewSpaceRoleAdded.html" class="tsd-kind-type-alias">NewSpaceRoleAdded</a></p>
|
|
164
165
|
<p>On the client side, a new role must be added to the participants listed in the NewSpaceRoleAdded.members</p>
|
|
165
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">role</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">permissions</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">permissions</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceRole.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceRole</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
166
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">role</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">permissions</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">permissions</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceRole.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceRole</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3017</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addUserEncryptionInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>User<wbr/>Encryption<wbr/>Info</span><a href="#addUserEncryptionInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addUserEncryptionInfo.addUserEncryptionInfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>User<wbr/>Encryption<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">info</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserEncryptionInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserEncryptionInfo</a><span class="tsd-signature-symbol">></span><a href="#addUserEncryptionInfo.addUserEncryptionInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>After adding:</p>
|
|
166
167
|
<p>User's contacts will see <a href="../types/constants.Contact.html#__type.encryptionEnabled" class="tsd-kind-property">Contact.encryptionEnabled</a> and <a href="../types/constants.Contact.html#__type.publicKey" class="tsd-kind-property">Contact.publicKey</a>.
|
|
167
168
|
The remaining information is not used on the server and is only stored; it can be requested using <a href="sfu_extended.SfuExtended.html#getUserEncryptionInfo" class="tsd-kind-method">getUserEncryptionInfo</a>.</p>
|
|
168
169
|
<p>verificationHash, salt, and iv are optional; the client chooses the private key encryption method.</p>
|
|
169
170
|
<p>salt - Cryptographic Salt</p>
|
|
170
171
|
<p>iv - Initialization Vector for Encryption</p>
|
|
171
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">info</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">iv</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">privateKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">publicKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">salt</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">verificationHash</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">iv</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">private<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">public<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">salt</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">verification<wbr/>Hash</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserEncryptionInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserEncryptionInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
172
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">email</span>: <span class="tsd-signature-type">string</span></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
172
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">info</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">iv</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">privateKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">publicKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">salt</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">verificationHash</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">iv</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">private<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">public<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">salt</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">verification<wbr/>Hash</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserEncryptionInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserEncryptionInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2023</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="changeUserEmail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>change<wbr/>User<wbr/>Email</span><a href="#changeUserEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="changeUserEmail.changeUserEmail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">change<wbr/>User<wbr/>Email</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">email</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#changeUserEmail.changeUserEmail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Change user email</p>
|
|
173
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">email</span>: <span class="tsd-signature-type">string</span></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1900</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="changeUserHostKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>change<wbr/>User<wbr/>Host<wbr/>Key</span><a href="#changeUserHostKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="changeUserHostKey.changeUserHostKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">change<wbr/>User<wbr/>Host<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">hostKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#changeUserHostKey.changeUserHostKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">hostKey</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1948</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="changeUserNickname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>change<wbr/>User<wbr/>Nickname</span><a href="#changeUserNickname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="changeUserNickname.changeUserNickname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">change<wbr/>User<wbr/>Nickname</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nickname</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#changeUserNickname.changeUserNickname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Change user email</p>
|
|
173
174
|
<p>Users will receive <a href="../enums/constants.SfuEvent.html#CONTACT_UPDATED" class="tsd-kind-enum-member">SfuEvent.CONTACT_UPDATED</a> with changed nickname</p>
|
|
174
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nickname</span>: <span class="tsd-signature-type">string</span></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
175
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nickname</span>: <span class="tsd-signature-type">string</span></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1928</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="changeUserPassword" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>change<wbr/>User<wbr/>Password</span><a href="#changeUserPassword" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="changeUserPassword.changeUserPassword-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">change<wbr/>User<wbr/>Password</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">currentPassword</span>, <span class="tsd-kind-parameter">newPassword</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#changeUserPassword.changeUserPassword-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">currentPassword</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">newPassword</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1910</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="changeUserPhoneNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>change<wbr/>User<wbr/>Phone<wbr/>Number</span><a href="#changeUserPhoneNumber" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="changeUserPhoneNumber.changeUserPhoneNumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">change<wbr/>User<wbr/>Phone<wbr/>Number</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">phoneNumber</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#changeUserPhoneNumber.changeUserPhoneNumber-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">phoneNumber</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1938</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="changeUserTimezone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>change<wbr/>User<wbr/>Timezone</span><a href="#changeUserTimezone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="changeUserTimezone.changeUserTimezone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">change<wbr/>User<wbr/>Timezone</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timezone</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#changeUserTimezone.changeUserTimezone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">timezone</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1958</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="closePcAndFireEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>close<wbr/>Pc<wbr/>And<wbr/>Fire<wbr/>Event</span><a href="#closePcAndFireEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="closePcAndFireEvent.closePcAndFireEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">close<wbr/>Pc<wbr/>And<wbr/>Fire<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">room</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#closePcAndFireEvent.closePcAndFireEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">room</span>: <a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3313</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="connect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="connect.connect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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><a href="#connect.connect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Connects the user to the server.</p>
|
|
175
176
|
<p>The user can connect using either a username and password or an authToken.</p>
|
|
176
177
|
<p>Once the connection is successful, the <a href="sfu_extended.SfuExtended.html#state" class="tsd-kind-method">state</a> will change to <a href="../enums/constants.State.html#AUTHENTICATED" class="tsd-kind-enum-member">State.AUTHENTICATED</a>.
|
|
177
178
|
After that, the sfu-sdk will emit the event <a href="../enums/constants.SfuEvent.html#CONNECTED" class="tsd-kind-enum-member">SfuEvent.CONNECTED</a>.</p>
|
|
@@ -179,162 +180,163 @@ After that, the sfu-sdk will emit the event <a href="../enums/constants.SfuEvent
|
|
|
179
180
|
<p>After successfully connection user contacts will receive an <a href="../enums/constants.SfuEvent.html#USER_PRESENCE_STATUS_UPDATED" class="tsd-kind-enum-member">SfuEvent.USER_PRESENCE_STATUS_UPDATED</a> with <a href="../types/constants.UserPresenceStatusUpdated.html" class="tsd-kind-type-alias">UserPresenceStatusUpdated</a></p>
|
|
180
181
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">binary<wbr/>Chunk<wbr/>Size</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">details</span><span class="tsd-signature-symbol">?: </span><a href="../types/constants.ConnectionDetails.html" class="tsd-signature-type tsd-kind-type-alias">ConnectionDetails</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">device</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">failed<wbr/>Probes<wbr/>Threshold</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The user's password (optional if <code>authToken</code> is provided).</p>
|
|
181
182
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">ping<wbr/>Interval</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The user's username (optional if <code>authToken</code> is provided).</p>
|
|
182
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></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-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
183
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></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-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:231</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createChannelMeeting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Channel<wbr/>Meeting</span><a href="#createChannelMeeting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createChannelMeeting.createChannelMeeting-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Channel<wbr/>Meeting</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span><a href="#createChannelMeeting.createChannelMeeting-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create channel meeting</p>
|
|
183
184
|
<p>Room.id() will be equal channelId</p>
|
|
184
185
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span></h4><p>RoomExtended with <a href="room_extended.RoomExtended.html#conferenceType" class="tsd-kind-method">()</a> that equal ConferenceType.CHANNEL</p>
|
|
185
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
186
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">allowedToAddExternalUser</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">channel</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">channelSendPolicy</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">encryptedChatPasswords</span><span class="tsd-signature-symbol">?: </span><a href="../types/constants.UserChatEncryptedPassword.html" class="tsd-signature-type tsd-kind-type-alias">UserChatEncryptedPassword</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">encryptedPrivateKey</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">favourite</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isEncryptionEnabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">publicKey</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sendPermissionList</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChatType.html" class="tsd-signature-type tsd-kind-enum">ChatType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">allowed<wbr/>To<wbr/>Add<wbr/>External<wbr/>User</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">channel</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">channel<wbr/>Send<wbr/>Policy</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a></h5><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">encrypted<wbr/>
|
|
186
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2442</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createChat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">create<wbr/>Chat</span><a href="#createChat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createChat.createChat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Chat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#createChat.createChat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create chat</p>
|
|
187
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">allowedToAddExternalUser</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">channel</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">channelSendPolicy</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">encryptedAttachmentsSecretKey</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">encryptedChatPasswords</span><span class="tsd-signature-symbol">?: </span><a href="../types/constants.UserChatEncryptedPassword.html" class="tsd-signature-type tsd-kind-type-alias">UserChatEncryptedPassword</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">encryptedPrivateKey</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">favourite</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isEncryptionEnabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">publicKey</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sendPermissionList</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChatType.html" class="tsd-signature-type tsd-kind-enum">ChatType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">allowed<wbr/>To<wbr/>Add<wbr/>External<wbr/>User</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">channel</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">channel<wbr/>Send<wbr/>Policy</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a></h5><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">encrypted<wbr/>Attachments<wbr/>Secret<wbr/>Key</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>encrypted key for encrypting attachments.</p>
|
|
188
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">encrypted<wbr/>Chat<wbr/>Passwords</span><span class="tsd-signature-symbol">?: </span><a href="../types/constants.UserChatEncryptedPassword.html" class="tsd-signature-type tsd-kind-type-alias">UserChatEncryptedPassword</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>an array of chat passwords for each member encrypted with the member's public keys, which must be decrypted using the user's private key.</p>
|
|
187
189
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">encrypted<wbr/>Private<wbr/>Key</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the private key of the chat, encrypted with a chat password, used to decrypt messages</p>
|
|
188
190
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">favourite</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">is<wbr/>Encryption<wbr/>Enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>must be true for a Secure Chat</p>
|
|
189
191
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>these members will receive <a href="../enums/constants.SfuEvent.html#NEW_CHAT" class="tsd-kind-enum-member">SfuEvent.NEW_CHAT</a> with <a href="../types/constants.UserSpecificChatInfo.html" class="tsd-kind-type-alias">UserSpecificChatInfo</a></p>
|
|
190
192
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">public<wbr/>Key</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the public key of the chat used to encrypt messages</p>
|
|
191
193
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">send<wbr/>Permission<wbr/>List</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChatType.html" class="tsd-signature-type tsd-kind-enum">ChatType</a></h5><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4><h4>Deprecated</h4><h4>Deprecated</h4><h4>Deprecated</h4><p>Creating a Secure Chat with Encryption:</p>
|
|
192
|
-
</div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
194
|
+
</div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2183</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createDirectMeeting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Direct<wbr/>Meeting</span><a href="#createDirectMeeting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createDirectMeeting.createDirectMeeting-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Direct<wbr/>Meeting</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span><a href="#createDirectMeeting.createDirectMeeting-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create channel meeting</p>
|
|
193
195
|
<p>Room.id() will be equal directChatId</p>
|
|
194
196
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">directChatId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">direct<wbr/>Chat<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span></h4><p>RoomExtended with <a href="room_extended.RoomExtended.html#conferenceType" class="tsd-kind-method">()</a> that equal ConferenceType.DIRECT</p>
|
|
195
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
197
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2463</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createRoom" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Room</span><a href="#createRoom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createRoom.createRoom-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Room</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span><a href="#createRoom.createRoom-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create room</p>
|
|
196
198
|
<p>To create with PMI settings, PMI must be specified as the ID.</p>
|
|
197
199
|
<p>To join, you need to use room.join.</p>
|
|
198
200
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pin</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">pin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span></h4><p>RoomExtended with <a href="room_extended.RoomExtended.html#conferenceType" class="tsd-kind-method">()</a> that equal ConferenceType.GLOBAL</p>
|
|
199
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
201
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2419</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createRoomFromEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Room<wbr/>From<wbr/>Event</span><a href="#createRoomFromEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createRoomFromEvent.createRoomFromEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Room<wbr/>From<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span><a href="#createRoomFromEvent.createRoomFromEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creating a room based on a calendar event created using <a href="sfu_extended.SfuExtended.html#addCalendarEvent" class="tsd-kind-method">addCalendarEvent</a>.</p>
|
|
200
202
|
<p>To join, you need to use room.join()</p>
|
|
201
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">accessCode</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">allowJoinAtAnyTime</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">ownerVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">participantVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">recurring</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useLocalAutoRecord</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useMuteAudioOnJoin</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">usePMI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">waitingRoom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">access<wbr/>Code</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">allow<wbr/>Join<wbr/>At<wbr/>Any<wbr/>Time</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">owner<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">participant<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">recurring</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Local<wbr/>Auto<wbr/>Record</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Mute<wbr/>Audio<wbr/>On<wbr/>Join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">usePMI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">waiting<wbr/>Room</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
202
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">space</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">name</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpace.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpace</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
203
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">accessCode</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">allowJoinAtAnyTime</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">ownerVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">participantVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">recurring</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useLocalAutoRecord</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useMuteAudioOnJoin</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">usePMI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">waitingRoom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">access<wbr/>Code</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">allow<wbr/>Join<wbr/>At<wbr/>Any<wbr/>Time</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">owner<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">participant<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">recurring</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Local<wbr/>Auto<wbr/>Record</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Mute<wbr/>Audio<wbr/>On<wbr/>Join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">usePMI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">waiting<wbr/>Room</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2480</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createSpace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Space</span><a href="#createSpace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createSpace.createSpace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Space</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">space</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpace.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpace</a><span class="tsd-signature-symbol">></span><a href="#createSpace.createSpace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The space is created with the default category Category1, default channel Channel1 and default role "@everyone".</p>
|
|
204
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">space</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">name</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpace.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpace</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2578</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createSpaceCategory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Space<wbr/>Category</span><a href="#createSpaceCategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createSpaceCategory.createSpaceCategory-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Space<wbr/>Category</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">category</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceCategory.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceCategory</a><span class="tsd-signature-symbol">></span><a href="#createSpaceCategory.createSpaceCategory-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create space category</p>
|
|
203
205
|
<p>For space owner/user that has permission to manage categories</p>
|
|
204
206
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#NEW_SPACE_CATEGORY" class="tsd-kind-enum-member">SpaceEvent.NEW_SPACE_CATEGORY</a> with <a href="../types/constants.NewSpaceCategoryEvent.html" class="tsd-kind-type-alias">NewSpaceCategoryEvent</a></p>
|
|
205
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">category</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceCategory.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceCategory</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
207
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">category</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceCategory.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceCategory</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2712</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createSpaceChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Space<wbr/>Channel</span><a href="#createSpaceChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createSpaceChannel.createSpaceChannel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Space<wbr/>Channel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceChannel.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceChannel</a><span class="tsd-signature-symbol">></span><a href="#createSpaceChannel.createSpaceChannel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create space channel</p>
|
|
206
208
|
<p>For space owner/user that has permission to manage channels</p>
|
|
207
209
|
<p>Channel members will receive <a href="../enums/constants.SpaceEvent.html#NEW_SPACE_CHANNEL" class="tsd-kind-enum-member">SpaceEvent.NEW_SPACE_CHANNEL</a> with <a href="../types/constants.NewSpaceChannelEvent.html" class="tsd-kind-type-alias">NewSpaceChannelEvent</a></p>
|
|
208
210
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">channel</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">categoryId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isPrivate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">roles</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">category<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">is<wbr/>Private</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>used to create a private channel. Array of member ids or empty array.</p>
|
|
209
211
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">roles</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>used to create a private channel. Array of role ids or empty array.</p>
|
|
210
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceChannel.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceChannel</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
212
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceChannel.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceChannel</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2780</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createSpaceThread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Space<wbr/>Thread</span><a href="#createSpaceThread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createSpaceThread.createSpaceThread-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Space<wbr/>Thread</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">thread</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceThread.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceThread</a><span class="tsd-signature-symbol">></span><a href="#createSpaceThread.createSpaceThread-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create space thread</p>
|
|
211
213
|
<p>Thread members will receive <a href="../enums/constants.SpaceEvent.html#NEW_SPACE_THREAD" class="tsd-kind-enum-member">SpaceEvent.NEW_SPACE_THREAD</a> with <a href="../types/constants.NewSpaceThreadEvent.html" class="tsd-kind-type-alias">NewSpaceThreadEvent</a></p>
|
|
212
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">thread</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isPrivate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">is<wbr/>Private</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceThread.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceThread</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
214
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">thread</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isPrivate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">is<wbr/>Private</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceThread.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceThread</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2889</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteChat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Chat</span><a href="#deleteChat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteChat.deleteChat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Chat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteChat.deleteChat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete chat</p>
|
|
213
215
|
<p>Chat members will receive <a href="../enums/constants.SfuEvent.html#CHAT_DELETED" class="tsd-kind-enum-member">SfuEvent.CHAT_DELETED</a> with <a href="../types/constants.UserSpecificChatInfo.html" class="tsd-kind-type-alias">UserSpecificChatInfo</a></p>
|
|
214
216
|
<p>If a direct meeting was started, it will end, and chat participants will receive <a href="../enums/constants.MeetingSyncEvent.html#MEETING_ENDED_SYNC" class="tsd-kind-enum-member">MeetingSyncEvent.MEETING_ENDED_SYNC</a> with <a href="../types/constants.MeetingEndedSync.html" class="tsd-kind-type-alias">MeetingEndedSync</a>.</p>
|
|
215
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
217
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2228</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Message</span><a href="#deleteMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteMessage.deleteMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteMessage.deleteMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete a message in a Direct chat | Channel | Thread</p>
|
|
216
218
|
<p>The message body will be changed to an empty string.
|
|
217
219
|
The <a href="../types/constants.Message.html#__type.status" class="tsd-kind-property">Message.status</a> will be changed to MessageState.DELETED</p>
|
|
218
220
|
<p>Attachments will be removed.</p>
|
|
219
221
|
<p>Members will receive <a href="../enums/constants.SfuEvent.html#CHAT_MESSAGE_DELETED" class="tsd-kind-enum-member">SfuEvent.CHAT_MESSAGE_DELETED</a> with <a href="../types/constants.MessageDeleted.html" class="tsd-kind-type-alias">MessageDeleted</a></p>
|
|
220
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">messageId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">message<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
222
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">messageId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">message<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1287</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteSpace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Space</span><a href="#deleteSpace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteSpace.deleteSpace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Space</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">space</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#deleteSpace.deleteSpace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete space</p>
|
|
221
223
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_DELETED" class="tsd-kind-enum-member">SpaceEvent.SPACE_DELETED</a> with <a href="../types/constants.SpaceDeletedEvent.html" class="tsd-kind-type-alias">SpaceDeletedEvent</a></p>
|
|
222
224
|
<p>If channel meetings were started, users will receive <a href="../enums/constants.MeetingSyncEvent.html#MEETING_ENDED_SYNC" class="tsd-kind-enum-member">MeetingSyncEvent.MEETING_ENDED_SYNC</a> with <a href="../types/constants.MeetingEndedSync.html" class="tsd-kind-type-alias">MeetingEndedSync</a>.</p>
|
|
223
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">space</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
225
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">space</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2616</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteSpaceCategory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Space<wbr/>Category</span><a href="#deleteSpaceCategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteSpaceCategory.deleteSpaceCategory-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Space<wbr/>Category</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceCategory.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceCategory</a><span class="tsd-signature-symbol">></span><a href="#deleteSpaceCategory.deleteSpaceCategory-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete space category</p>
|
|
224
226
|
<p>For space owner/category creator/user that has permission to manage categories</p>
|
|
225
227
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CATEGORY_DELETED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CATEGORY_DELETED</a> with <a href="../types/constants.SpaceCategoryDeleted.html" class="tsd-kind-type-alias">SpaceCategoryDeleted</a></p>
|
|
226
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">categoryId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">category<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceCategory.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceCategory</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
228
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">categoryId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">category<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceCategory.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceCategory</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2733</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteSpaceChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Space<wbr/>Channel</span><a href="#deleteSpaceChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteSpaceChannel.deleteSpaceChannel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Space<wbr/>Channel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteSpaceChannel.deleteSpaceChannel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete space channel</p>
|
|
227
229
|
<p>Channel members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CHANNEL_DELETED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CHANNEL_DELETED</a> with <a href="../types/constants.SpaceChannelDeleted.html" class="tsd-kind-type-alias">SpaceChannelDeleted</a></p>
|
|
228
230
|
<p>If the channel meeting was started, members will receive <a href="../enums/constants.MeetingSyncEvent.html#MEETING_ENDED_SYNC" class="tsd-kind-enum-member">MeetingSyncEvent.MEETING_ENDED_SYNC</a> with <a href="../types/constants.MeetingEndedSync.html" class="tsd-kind-type-alias">MeetingEndedSync</a>.</p>
|
|
229
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
231
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2870</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteSpaceRole" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Space<wbr/>Role</span><a href="#deleteSpaceRole" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteSpaceRole.deleteSpaceRole-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Space<wbr/>Role</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceRoleDeleted.html" class="tsd-signature-type tsd-kind-type-alias">SpaceRoleDeleted</a><span class="tsd-signature-symbol">></span><a href="#deleteSpaceRole.deleteSpaceRole-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete space role</p>
|
|
230
232
|
<p>For space owner/user that has permission to manage roles</p>
|
|
231
233
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_ROLE_DELETED" class="tsd-kind-enum-member">SpaceEvent.SPACE_ROLE_DELETED</a> with <a href="../types/constants.SpaceRoleDeleted.html" class="tsd-kind-type-alias">SpaceRoleDeleted</a></p>
|
|
232
234
|
<p>On the client side, should remove this role from channel's access rights and update channel members list</p>
|
|
233
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">roleId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">role<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceRoleDeleted.html" class="tsd-signature-type tsd-kind-type-alias">SpaceRoleDeleted</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
235
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">roleId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">role<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceRoleDeleted.html" class="tsd-signature-type tsd-kind-type-alias">SpaceRoleDeleted</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3084</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteSpaceThread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Space<wbr/>Thread</span><a href="#deleteSpaceThread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteSpaceThread.deleteSpaceThread-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Space<wbr/>Thread</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteSpaceThread.deleteSpaceThread-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete space thread</p>
|
|
234
236
|
<p>For space owner/thread creator</p>
|
|
235
237
|
<p>Thread members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_THREAD_DELETED" class="tsd-kind-enum-member">SpaceEvent.SPACE_THREAD_DELETED</a> with <a href="../types/constants.SpaceThreadDeleted.html" class="tsd-kind-type-alias">SpaceThreadDeleted</a></p>
|
|
236
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">threadId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">thread<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
238
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">threadId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">thread<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2992</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="disconnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disconnect</span><a href="#disconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="disconnect.disconnect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disconnect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#disconnect.disconnect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Method to disconnect from the server</p>
|
|
237
239
|
<p>When disconnecting, user leaves all active rooms</p>
|
|
238
240
|
<p><a href="sfu_extended.SfuExtended.html#state" class="tsd-kind-method">state</a> changed to <a href="../enums/constants.State.html#DISCONNECTED" class="tsd-kind-enum-member">DISCONNECTED</a></p>
|
|
239
241
|
<p>After disconnection user contacts will receive an <a href="../enums/constants.SfuEvent.html#USER_PRESENCE_STATUS_UPDATED" class="tsd-kind-enum-member">SfuEvent.USER_PRESENCE_STATUS_UPDATED</a> with <a href="../types/constants.UserPresenceStatusUpdated.html" class="tsd-kind-type-alias">UserPresenceStatusUpdated</a></p>
|
|
240
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
242
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:855</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="downloadAttachment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>download<wbr/>Attachment</span><a href="#downloadAttachment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="downloadAttachment.downloadAttachment-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">download<wbr/>Attachment</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attachment</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Attachment.html" class="tsd-signature-type tsd-kind-type-alias">Attachment</a><span class="tsd-signature-symbol">></span><a href="#downloadAttachment.downloadAttachment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">attachment</span>: <a href="../types/constants.AttachmentRequest.html" class="tsd-signature-type tsd-kind-type-alias">AttachmentRequest</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Attachment.html" class="tsd-signature-type tsd-kind-type-alias">Attachment</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1630</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="editMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>edit<wbr/>Message</span><a href="#editMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="editMessage.editMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">edit<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageStatus.html" class="tsd-signature-type tsd-kind-type-alias">MessageStatus</a><span class="tsd-signature-symbol">></span><a href="#editMessage.editMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Edit a message in a Direct chat | Channel | Thread</p>
|
|
241
243
|
<p>Members will receive <a href="../enums/constants.SfuEvent.html#CHAT_MESSAGE_EDITED" class="tsd-kind-enum-member">SfuEvent.CHAT_MESSAGE_EDITED</a> with <a href="../types/constants.MessageEdited.html" class="tsd-kind-type-alias">MessageEdited</a></p>
|
|
242
244
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">attachmentIdsToDelete</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">attachmentsToSend</span><span class="tsd-signature-symbol">?: </span><a href="../types/constants.MessageAttachment.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">messageId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">attachment<wbr/>Ids<wbr/>To<wbr/>Delete</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>to send a private message</p>
|
|
243
245
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">attachments<wbr/>To<wbr/>Send</span><span class="tsd-signature-symbol">?: </span><a href="../types/constants.MessageAttachment.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachment</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>to add attachments to sent message</p>
|
|
244
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">message<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageStatus.html" class="tsd-signature-type tsd-kind-type-alias">MessageStatus</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
246
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">message<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageStatus.html" class="tsd-signature-type tsd-kind-type-alias">MessageStatus</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1255</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="ensureUsernameAvailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ensure<wbr/>Username<wbr/>Available</span><a href="#ensureUsernameAvailable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ensureUsernameAvailable.ensureUsernameAvailable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ensure<wbr/>Username<wbr/>Available</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#ensureUsernameAvailable.ensureUsernameAvailable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Ensure username available</p>
|
|
245
247
|
<p>If the username is not taken, the promise will resolve with <code>void</code>.</p>
|
|
246
248
|
<p>If the username is taken, the promise will reject with <a href="../enums/constants.UserManagementError.html#USERNAME_ALREADY_IN_USE" class="tsd-kind-enum-member">UserManagementError.USERNAME_ALREADY_IN_USE</a>.</p>
|
|
247
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
249
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:951</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="generateNewSpaceInvite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>generate<wbr/>New<wbr/>Space<wbr/>Invite</span><a href="#generateNewSpaceInvite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="generateNewSpaceInvite.generateNewSpaceInvite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>New<wbr/>Space<wbr/>Invite</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceInvite.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceInvite</a><span class="tsd-signature-symbol">></span><a href="#generateNewSpaceInvite.generateNewSpaceInvite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Generate space invite</p>
|
|
248
250
|
<p>If user has permission to create a space invite - generating invite code with 8 symbols.
|
|
249
251
|
To create invite link - use 'ws:{serverUrl}:{port}/join-space/inviteCode'</p>
|
|
250
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">lifespan</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">lifespan</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceInvite.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceInvite</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
252
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">lifespan</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">lifespan</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceInvite.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceInvite</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2656</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getContacts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Contacts</span><a href="#getContacts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getContacts.getContacts-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Contacts</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserContacts.html" class="tsd-signature-type tsd-kind-type-alias">UserContacts</a><span class="tsd-signature-symbol">></span><a href="#getContacts.getContacts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get user contacts.</p>
|
|
251
253
|
<p>Returns users who are friends or with whom there are mutual space channels or direct chats, incoming and outgoing friend invites, banned users.</p>
|
|
252
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserContacts.html" class="tsd-signature-type tsd-kind-type-alias">UserContacts</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
253
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.FirstAndLastChatMessage.html" class="tsd-signature-type tsd-kind-type-alias">FirstAndLastChatMessage</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
254
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserContacts.html" class="tsd-signature-type tsd-kind-type-alias">UserContacts</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1660</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getExamplesFreeUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Examples<wbr/>Free<wbr/>User</span><a href="#getExamplesFreeUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getExamplesFreeUser.getExamplesFreeUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Examples<wbr/>Free<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ExamplesUser.html" class="tsd-signature-type tsd-kind-type-alias">ExamplesUser</a><span class="tsd-signature-symbol">></span><a href="#getExamplesFreeUser.getExamplesFreeUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ExamplesUser.html" class="tsd-signature-type tsd-kind-type-alias">ExamplesUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3216</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFirstAndLastMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>First<wbr/>And<wbr/>Last<wbr/>Message</span><a href="#getFirstAndLastMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFirstAndLastMessage.getFirstAndLastMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>First<wbr/>And<wbr/>Last<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.FirstAndLastChatMessage.html" class="tsd-signature-type tsd-kind-type-alias">FirstAndLastChatMessage</a><span class="tsd-signature-symbol">></span><a href="#getFirstAndLastMessage.getFirstAndLastMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get first message and last message in entity from <a href="../enums/constants.MessageTargetEntityType.html" class="tsd-kind-enum">MessageTargetEntityType</a></p>
|
|
255
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.FirstAndLastChatMessage.html" class="tsd-signature-type tsd-kind-type-alias">FirstAndLastChatMessage</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1432</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getMessageAttachment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Message<wbr/>Attachment</span><a href="#getMessageAttachment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getMessageAttachment.getMessageAttachment-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Message<wbr/>Attachment</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attachment</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Attachment.html" class="tsd-signature-type tsd-kind-type-alias">Attachment</a><span class="tsd-signature-symbol">></span><a href="#getMessageAttachment.getMessageAttachment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load attachment from server</p>
|
|
254
256
|
<p>On client side should receive <a href="../enums/constants.SfuEvent.html#MESSAGE_ATTACHMENT_STATE" class="tsd-kind-enum-member">SfuEvent.MESSAGE_ATTACHMENT_STATE</a> with <a href="../types/constants.AttachmentStatus.html" class="tsd-kind-type-alias">AttachmentStatus</a> to show progress</p>
|
|
255
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">attachment</span>: <a href="../types/constants.AttachmentRequest.html" class="tsd-signature-type tsd-kind-type-alias">AttachmentRequest</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Attachment.html" class="tsd-signature-type tsd-kind-type-alias">Attachment</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
256
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ChatMessagesCount.html" class="tsd-signature-type tsd-kind-type-alias">ChatMessagesCount</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
257
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">attachment</span>: <a href="../types/constants.AttachmentRequest.html" class="tsd-signature-type tsd-kind-type-alias">AttachmentRequest</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Attachment.html" class="tsd-signature-type tsd-kind-type-alias">Attachment</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1620</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getMessagesCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Messages<wbr/>Count</span><a href="#getMessagesCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getMessagesCount.getMessagesCount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Messages<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ChatMessagesCount.html" class="tsd-signature-type tsd-kind-type-alias">ChatMessagesCount</a><span class="tsd-signature-symbol">></span><a href="#getMessagesCount.getMessagesCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get messages count in entity from <a href="../enums/constants.MessageTargetEntityType.html" class="tsd-kind-enum">MessageTargetEntityType</a></p>
|
|
258
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ChatMessagesCount.html" class="tsd-signature-type tsd-kind-type-alias">ChatMessagesCount</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1415</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getPublicChannels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Public<wbr/>Channels</span><a href="#getPublicChannels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getPublicChannels.getPublicChannels-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Public<wbr/>Channels</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ChatMap.html" class="tsd-signature-type tsd-kind-type-alias">ChatMap</a><span class="tsd-signature-symbol">></span><a href="#getPublicChannels.getPublicChannels-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ChatMap.html" class="tsd-signature-type tsd-kind-type-alias">ChatMap</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2054</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRolePermissions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Role<wbr/>Permissions</span><a href="#getRolePermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRolePermissions.getRolePermissions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Role<wbr/>Permissions</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceRolePermissionSection.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceRolePermissionSection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getRolePermissions.getRolePermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceRolePermissionSection.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceRolePermissionSection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3150</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRoom" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Room</span><a href="#getRoom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRoom.getRoom-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Room</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><a href="#getRoom.getRoom-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2552</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSendingAttachmentsHandler" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Sending<wbr/>Attachments<wbr/>Handler</span><a href="#getSendingAttachmentsHandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSendingAttachmentsHandler.getSendingAttachmentsHandler-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Sending<wbr/>Attachments<wbr/>Handler</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attachments</span>, <span class="tsd-kind-parameter">messageId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sending_attachments_handler.SendingAttachmentsHandler.html" class="tsd-signature-type tsd-kind-class">SendingAttachmentsHandler</a><a href="#getSendingAttachmentsHandler.getSendingAttachmentsHandler-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get handler for send or cancel sending attachments</p>
|
|
257
259
|
<p>Can't cancel sent attachment</p>
|
|
258
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">attachments</span>: <a href="../types/constants.MessageAttachmentData.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachmentData</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">messageId</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="sending_attachments_handler.SendingAttachmentsHandler.html" class="tsd-signature-type tsd-kind-class">SendingAttachmentsHandler</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
259
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UnreadMessagesCountEvent.html" class="tsd-signature-type tsd-kind-type-alias">UnreadMessagesCountEvent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
260
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Calendar.html" class="tsd-signature-type tsd-kind-type-alias">Calendar</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
260
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">attachments</span>: <a href="../types/constants.MessageAttachmentData.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachmentData</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">messageId</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="sending_attachments_handler.SendingAttachmentsHandler.html" class="tsd-signature-type tsd-kind-class">SendingAttachmentsHandler</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1477</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUnreadMessagesCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Unread<wbr/>Messages<wbr/>Count</span><a href="#getUnreadMessagesCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUnreadMessagesCount.getUnreadMessagesCount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Unread<wbr/>Messages<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UnreadMessagesCountEvent.html" class="tsd-signature-type tsd-kind-type-alias">UnreadMessagesCountEvent</a><span class="tsd-signature-symbol">></span><a href="#getUnreadMessagesCount.getUnreadMessagesCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get count of unread messages in entity from <a href="../enums/constants.MessageTargetEntityType.html" class="tsd-kind-enum">MessageTargetEntityType</a></p>
|
|
261
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UnreadMessagesCountEvent.html" class="tsd-signature-type tsd-kind-type-alias">UnreadMessagesCountEvent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1449</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUserCalendar" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Calendar</span><a href="#getUserCalendar" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUserCalendar.getUserCalendar-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Calendar</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Calendar.html" class="tsd-signature-type tsd-kind-type-alias">Calendar</a><span class="tsd-signature-symbol">></span><a href="#getUserCalendar.getUserCalendar-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get all user calendar events</p>
|
|
262
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Calendar.html" class="tsd-signature-type tsd-kind-type-alias">Calendar</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1770</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUserChats" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Chats</span><a href="#getUserChats" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUserChats.getUserChats-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Chats</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ChatMap.html" class="tsd-signature-type tsd-kind-type-alias">ChatMap</a><span class="tsd-signature-symbol">></span><a href="#getUserChats.getUserChats-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get chats.</p>
|
|
261
263
|
<p>To work with messages in the chat, you need to use <a href="../enums/constants.MessageTargetEntityType.html#CHAT" class="tsd-kind-enum-member">MessageTargetEntityType.CHAT</a></p>
|
|
262
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ChatMap.html" class="tsd-signature-type tsd-kind-type-alias">ChatMap</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
264
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.ChatMap.html" class="tsd-signature-type tsd-kind-type-alias">ChatMap</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2149</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUserEncryptionInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Encryption<wbr/>Info</span><a href="#getUserEncryptionInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUserEncryptionInfo.getUserEncryptionInfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Encryption<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserEncryptionInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserEncryptionInfo</a><span class="tsd-signature-symbol">></span><a href="#getUserEncryptionInfo.getUserEncryptionInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserEncryptionInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserEncryptionInfo</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2043</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUserInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Info</span><a href="#getUserInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUserInfo.getUserInfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><span class="tsd-signature-symbol">></span><a href="#getUserInfo.getUserInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get user info</p>
|
|
263
265
|
<p>Usually used to display profile info</p>
|
|
264
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
266
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1889</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUserPmiSettings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Pmi<wbr/>Settings</span><a href="#getUserPmiSettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUserPmiSettings.getUserPmiSettings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Pmi<wbr/>Settings</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserPmiSettings.html" class="tsd-signature-type tsd-kind-type-alias">UserPmiSettings</a><span class="tsd-signature-symbol">></span><a href="#getUserPmiSettings.getUserPmiSettings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get user pmi settings</p>
|
|
265
267
|
<p>Used for create meetings</p>
|
|
266
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserPmiSettings.html" class="tsd-signature-type tsd-kind-type-alias">UserPmiSettings</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
268
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserPmiSettings.html" class="tsd-signature-type tsd-kind-type-alias">UserPmiSettings</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1854</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUserSpaces" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Spaces</span><a href="#getUserSpaces" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUserSpaces.getUserSpaces-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Spaces</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpace.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpace</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getUserSpaces.getUserSpaces-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get user spaces</p>
|
|
267
269
|
<p>If channel meetings were started, user will receive <a href="../enums/constants.SfuEvent.html#USER_MEETINGS" class="tsd-kind-enum-member">SfuEvent.USER_MEETINGS</a> with <a href="../types/constants.MeetingsPreviewEvent.html" class="tsd-kind-type-alias">MeetingsPreviewEvent</a>.</p>
|
|
268
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpace.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpace</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
270
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpace.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpace</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2567</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="joinSpaceByInviteCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>join<wbr/>Space<wbr/>By<wbr/>Invite<wbr/>Code</span><a href="#joinSpaceByInviteCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="joinSpaceByInviteCode.joinSpaceByInviteCode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">join<wbr/>Space<wbr/>By<wbr/>Invite<wbr/>Code</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inviteCode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpace.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpace</a><span class="tsd-signature-symbol">></span><a href="#joinSpaceByInviteCode.joinSpaceByInviteCode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Join space by invite code</p>
|
|
269
271
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#USER_JOINED_TO_SPACE" class="tsd-kind-enum-member">SpaceEvent.USER_JOINED_TO_SPACE</a> with <a href="../types/constants.UserJoinedToSpaceEvent.html" class="tsd-kind-type-alias">UserJoinedToSpaceEvent</a>.
|
|
270
272
|
On the client side, this user should be added to the list of participants in public channels and threads.</p>
|
|
271
273
|
<p>If channel meetings were started, user will receive <a href="../enums/constants.SfuEvent.html#USER_MEETINGS" class="tsd-kind-enum-member">SfuEvent.USER_MEETINGS</a> with <a href="../types/constants.MeetingsPreviewEvent.html" class="tsd-kind-type-alias">MeetingsPreviewEvent</a>.</p>
|
|
272
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">inviteCode</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpace.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpace</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
274
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">inviteCode</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpace.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpace</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2695</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leaveSpace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>leave<wbr/>Space</span><a href="#leaveSpace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="leaveSpace.leaveSpace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">leave<wbr/>Space</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">space</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#leaveSpace.leaveSpace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Leave space</p>
|
|
273
275
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#USER_LEFT_SPACE" class="tsd-kind-enum-member">SpaceEvent.USER_LEFT_SPACE</a> with <a href="../types/constants.UserLeftSpace.html" class="tsd-kind-type-alias">UserLeftSpace</a></p>
|
|
274
276
|
<p>After receiving the event, it is necessary to remove the user from the list of members in the space and channels/threads.</p>
|
|
275
277
|
<p>If channel meetings were started, user will receive <a href="../enums/constants.MeetingSyncEvent.html#MEETING_ENDED_SYNC" class="tsd-kind-enum-member">MeetingSyncEvent.MEETING_ENDED_SYNC</a> with <a href="../types/constants.MeetingEndedSync.html" class="tsd-kind-type-alias">MeetingEndedSync</a>.
|
|
276
278
|
If the user was a participant in the meeting, users will receive <a href="../enums/constants.RoomEvent.html#EVICTED" class="tsd-kind-enum-member">RoomEvent.EVICTED</a> with EvictedFromRoom.</p>
|
|
277
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">space</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
278
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.RoomInfo.html" class="tsd-signature-type tsd-kind-type-alias">RoomInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
279
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">space</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2638</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadActiveRooms" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Active<wbr/>Rooms</span><a href="#loadActiveRooms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadActiveRooms.loadActiveRooms-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Active<wbr/>Rooms</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.RoomInfo.html" class="tsd-signature-type tsd-kind-type-alias">RoomInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#loadActiveRooms.loadActiveRooms-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get running rooms</p>
|
|
280
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.RoomInfo.html" class="tsd-signature-type tsd-kind-type-alias">RoomInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2508</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadChat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Chat</span><a href="#loadChat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadChat.loadChat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Chat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Chat.html" class="tsd-signature-type tsd-kind-type-alias">Chat</a><span class="tsd-signature-symbol">></span><a href="#loadChat.loadChat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Chat.html" class="tsd-signature-type tsd-kind-type-alias">Chat</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2157</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadMessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Messages</span><a href="#loadMessages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadMessages.loadMessages-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Messages</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Message.html" class="tsd-signature-type tsd-kind-type-alias">Message</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#loadMessages.loadMessages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load messages for Direct chat | Channel | Thread</p>
|
|
279
281
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeFrame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>to load messages by specifying a particular message using its date,
|
|
280
282
|
along with the number of messages above and below it. Upper limit includes message with date dateMark.</p>
|
|
281
283
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">date<wbr/>Mark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">lower<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">upper<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">time<wbr/>Frame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>to load by start date to end date. For load all messages used with start = 0, end = -1.</p>
|
|
282
|
-
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Message.html" class="tsd-signature-type tsd-kind-type-alias">Message</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1174</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadMessagesWithMentions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">load<wbr/>Messages<wbr/>With<wbr/>Mentions</span><a href="#loadMessagesWithMentions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadMessagesWithMentions.loadMessagesWithMentions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Messages<wbr/>With<wbr/>Mentions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LoadMessagesWithMentionsResult.html" class="tsd-signature-type tsd-kind-type-alias">LoadMessagesWithMentionsResult</a><span class="tsd-signature-symbol">></span><a href="#loadMessagesWithMentions.loadMessagesWithMentions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">chatId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.SortOrder.html" class="tsd-signature-type tsd-kind-enum">SortOrder</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeFrame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">userTag</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">date<wbr/>Mark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">lower<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">upper<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">chat<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">sort<wbr/>Order</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.SortOrder.html" class="tsd-signature-type tsd-kind-enum">SortOrder</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">time<wbr/>Frame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">user<wbr/>Tag</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LoadMessagesWithMentionsResult.html" class="tsd-signature-type tsd-kind-type-alias">LoadMessagesWithMentionsResult</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2101</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="logout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>logout</span><a href="#logout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="logout.logout-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">logout</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LastReadMessageUpdated.html" class="tsd-signature-type tsd-kind-type-alias">LastReadMessageUpdated</a><span class="tsd-signature-symbol">></span><a href="#logout.logout-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Logout from app</p>
|
|
283
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><
|
|
284
|
+
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Message.html" class="tsd-signature-type tsd-kind-type-alias">Message</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1189</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadMessagesWithMentions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">load<wbr/>Messages<wbr/>With<wbr/>Mentions</span><a href="#loadMessagesWithMentions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadMessagesWithMentions.loadMessagesWithMentions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Messages<wbr/>With<wbr/>Mentions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LoadMessagesWithMentionsResult.html" class="tsd-signature-type tsd-kind-type-alias">LoadMessagesWithMentionsResult</a><span class="tsd-signature-symbol">></span><a href="#loadMessagesWithMentions.loadMessagesWithMentions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">chatId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.SortOrder.html" class="tsd-signature-type tsd-kind-enum">SortOrder</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeFrame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">userTag</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">date<wbr/>Mark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">lower<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">upper<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">chat<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">sort<wbr/>Order</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.SortOrder.html" class="tsd-signature-type tsd-kind-enum">SortOrder</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">time<wbr/>Frame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">user<wbr/>Tag</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LoadMessagesWithMentionsResult.html" class="tsd-signature-type tsd-kind-type-alias">LoadMessagesWithMentionsResult</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2116</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="logout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>logout</span><a href="#logout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="logout.logout-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">logout</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#logout.logout-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Logout from app</p>
|
|
285
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1161</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="markMessageRead" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mark<wbr/>Message<wbr/>Read</span><a href="#markMessageRead" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="markMessageRead.markMessageRead-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mark<wbr/>Message<wbr/>Read</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LastReadMessageUpdated.html" class="tsd-signature-type tsd-kind-type-alias">LastReadMessageUpdated</a><span class="tsd-signature-symbol">></span><a href="#markMessageRead.markMessageRead-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mark message as read in a Direct chat | Channel | Thread</p>
|
|
284
286
|
<p>In targetEntity will change lastReadMessageId and lastReadMessageDate</p>
|
|
285
287
|
<p>All unread messages with a <a href="../types/constants.Message.html#__type.date" class="tsd-kind-property">Message.date</a> earlier than or equal to the marked one will be marked as read.
|
|
286
288
|
The sender of each message will receive <a href="../enums/constants.SfuEvent.html#UPDATE_MESSAGES_DELIVERY_STATUS" class="tsd-kind-enum-member">SfuEvent.UPDATE_MESSAGES_DELIVERY_STATUS</a>
|
|
287
289
|
with <a href="../types/constants.UpdateMessagesDeliveryStatusEvent.html" class="tsd-kind-type-alias">UpdateMessagesDeliveryStatusEvent</a> and <a href="../types/constants.Message.html#__type.deliveryStatus" class="tsd-kind-property">Message.deliveryStatus</a> will be changed at the server side to DeliveryStatus.READ.</p>
|
|
288
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LastReadMessageUpdated.html" class="tsd-signature-type tsd-kind-type-alias">LastReadMessageUpdated</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
290
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LastReadMessageUpdated.html" class="tsd-signature-type tsd-kind-type-alias">LastReadMessageUpdated</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1358</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="markMessageUnread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mark<wbr/>Message<wbr/>Unread</span><a href="#markMessageUnread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="markMessageUnread.markMessageUnread-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mark<wbr/>Message<wbr/>Unread</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LastReadMessageUpdated.html" class="tsd-signature-type tsd-kind-type-alias">LastReadMessageUpdated</a><span class="tsd-signature-symbol">></span><a href="#markMessageUnread.markMessageUnread-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mark message as unread in a Direct chat | Channel | Thread</p>
|
|
289
291
|
<p>In targetEntity will change lastReadMessageId and lastReadMessageDate. <a href="../types/constants.Message.html#__type.deliveryStatus" class="tsd-kind-property">Message.deliveryStatus</a></p>
|
|
290
292
|
<p><a href="../types/constants.Message.html#__type.deliveryStatus" class="tsd-kind-property">Message.deliveryStatus</a> will not be changed at the server side. Senders will not receive events,
|
|
291
293
|
however if the previous lastReadMessageDate is earlier than the updated value,
|
|
292
294
|
the senders of those messages will receive <a href="../enums/constants.SfuEvent.html#UPDATE_MESSAGES_DELIVERY_STATUS" class="tsd-kind-enum-member">SfuEvent.UPDATE_MESSAGES_DELIVERY_STATUS</a>
|
|
293
295
|
with <a href="../types/constants.UpdateMessagesDeliveryStatusEvent.html" class="tsd-kind-type-alias">UpdateMessagesDeliveryStatusEvent</a> and <a href="../types/constants.Message.html#__type.deliveryStatus" class="tsd-kind-property">Message.deliveryStatus</a> will be changed at the server side to DeliveryStatus.READ.</p>
|
|
294
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LastReadMessageUpdated.html" class="tsd-signature-type tsd-kind-type-alias">LastReadMessageUpdated</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
296
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.LastReadMessageUpdated.html" class="tsd-signature-type tsd-kind-type-alias">LastReadMessageUpdated</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1390</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="moveSpaceChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>move<wbr/>Space<wbr/>Channel</span><a href="#moveSpaceChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="moveSpaceChannel.moveSpaceChannel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">move<wbr/>Space<wbr/>Channel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceChannelMoved.html" class="tsd-signature-type tsd-kind-type-alias">SpaceChannelMoved</a><span class="tsd-signature-symbol">></span><a href="#moveSpaceChannel.moveSpaceChannel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Move space channel</p>
|
|
295
297
|
<p>Channel members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CHANNEL_MOVED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CHANNEL_MOVED</a> with <a href="../types/constants.SpaceChannelMoved.html" class="tsd-kind-type-alias">SpaceChannelMoved</a></p>
|
|
296
298
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">channel</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">categoryId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">category<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Specify the identifier of the category to which you want to move the channel, or an empty string to leave the channel uncategorized.</p>
|
|
297
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceChannelMoved.html" class="tsd-signature-type tsd-kind-type-alias">SpaceChannelMoved</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
299
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceChannelMoved.html" class="tsd-signature-type tsd-kind-type-alias">SpaceChannelMoved</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2847</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="off.off-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sfu_extended.SfuExtended.html" class="tsd-signature-type tsd-kind-class">SfuExtended</a><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">event</span>: <a href="../types/sfu_extended.EventUnion.html" class="tsd-signature-type tsd-kind-type-alias">EventUnion</a></span></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg0</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg0</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li 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">arg0</span>: <a href="../types/sfu_extended.NotifyUnion.html" class="tsd-signature-type tsd-kind-type-alias">NotifyUnion</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="sfu_extended.SfuExtended.html" class="tsd-signature-type tsd-kind-class">SfuExtended</a></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3198</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="on.on-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sfu_extended.SfuExtended.html" class="tsd-signature-type tsd-kind-class">SfuExtended</a><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">event</span>: <a href="../types/sfu_extended.EventUnion.html" class="tsd-signature-type tsd-kind-type-alias">EventUnion</a></span></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg0</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg0</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li 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">arg0</span>: <a href="../types/sfu_extended.NotifyUnion.html" class="tsd-signature-type tsd-kind-type-alias">NotifyUnion</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="sfu_extended.SfuExtended.html" class="tsd-signature-type tsd-kind-class">SfuExtended</a></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3193</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rejectFriendInvite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reject<wbr/>Friend<wbr/>Invite</span><a href="#rejectFriendInvite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="rejectFriendInvite.rejectFriendInvite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reject<wbr/>Friend<wbr/>Invite</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">invite</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.FriendInviteDeleted.html" class="tsd-signature-type tsd-kind-type-alias">FriendInviteDeleted</a><span class="tsd-signature-symbol">></span><a href="#rejectFriendInvite.rejectFriendInvite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reject friend invite</p>
|
|
298
300
|
<p>Promise will resolve with <a href="../enums/constants.SfuEvent.html#INCOMING_FRIEND_INVITE_DELETED" class="tsd-kind-enum-member">SfuEvent.INCOMING_FRIEND_INVITE_DELETED</a> with <a href="../types/constants.FriendInviteDeleted.html" class="tsd-kind-type-alias">FriendInviteDeleted</a>.
|
|
299
301
|
Outgoing friend invite will not delete.</p>
|
|
300
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">invite</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">inviteId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">invite<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.FriendInviteDeleted.html" class="tsd-signature-type tsd-kind-type-alias">FriendInviteDeleted</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
301
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
302
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">invite</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">inviteId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">invite<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.FriendInviteDeleted.html" class="tsd-signature-type tsd-kind-type-alias">FriendInviteDeleted</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1755</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeCalendarEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Calendar<wbr/>Event</span><a href="#removeCalendarEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeCalendarEvent.removeCalendarEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Calendar<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.CalendarEvent.html" class="tsd-signature-type tsd-kind-type-alias">CalendarEvent</a><span class="tsd-signature-symbol">></span><a href="#removeCalendarEvent.removeCalendarEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">event</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.CalendarEvent.html" class="tsd-signature-type tsd-kind-type-alias">CalendarEvent</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1807</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeChannelSendPermissionListMember" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">remove<wbr/>Channel<wbr/>Send<wbr/>Permission<wbr/>List<wbr/>Member</span><a href="#removeChannelSendPermissionListMember" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeChannelSendPermissionListMember.removeChannelSendPermissionListMember-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Channel<wbr/>Send<wbr/>Permission<wbr/>List<wbr/>Member</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#removeChannelSendPermissionListMember.removeChannelSendPermissionListMember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">channel</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">member</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">member</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2353</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeChatFromFavourites" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Chat<wbr/>From<wbr/>Favourites</span><a href="#removeChatFromFavourites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeChatFromFavourites.removeChatFromFavourites-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Chat<wbr/>From<wbr/>Favourites</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#removeChatFromFavourites.removeChatFromFavourites-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Used to change <a href="../types/constants.UserSpecificChatInfo.html#__type.favourite" class="tsd-kind-property">UserSpecificChatInfo.favourite</a> to false</p>
|
|
303
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2400</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeFriend" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Friend</span><a href="#removeFriend" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeFriend.removeFriend-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Friend</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">friend</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#removeFriend.removeFriend-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove friend</p>
|
|
302
304
|
<p>Users will receive <a href="../enums/constants.SfuEvent.html#CONTACT_UPDATED" class="tsd-kind-enum-member">SfuEvent.CONTACT_UPDATED</a> with <a href="../types/constants.ContactUpdated.html" class="tsd-kind-type-alias">ContactUpdated</a> if they have mutual space channels or direct chats.
|
|
303
305
|
Will receive <a href="../enums/constants.SfuEvent.html#CONTACT_DELETED" class="tsd-kind-enum-member">SfuEvent.CONTACT_DELETED</a> with <a href="../types/constants.ContactDeleted.html" class="tsd-kind-type-alias">ContactDeleted</a> if haven't.</p>
|
|
304
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">friend</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">userId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">user<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
306
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">friend</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">userId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">user<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1701</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeMemberFromChat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Member<wbr/>From<wbr/>Chat</span><a href="#removeMemberFromChat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeMemberFromChat.removeMemberFromChat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Member<wbr/>From<wbr/>Chat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#removeMemberFromChat.removeMemberFromChat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove a member to chat</p>
|
|
305
307
|
<p>Chat members will receive <a href="../enums/constants.SfuEvent.html#CHAT_UPDATED" class="tsd-kind-enum-member">SfuEvent.CHAT_UPDATED</a> with <a href="../types/constants.UserSpecificChatInfo.html" class="tsd-kind-type-alias">UserSpecificChatInfo</a></p>
|
|
306
308
|
<p>If a direct meeting was started and user was , user will receive <a href="../enums/constants.MeetingSyncEvent.html#MEETING_ENDED_SYNC" class="tsd-kind-enum-member">MeetingSyncEvent.MEETING_ENDED_SYNC</a> with <a href="../types/constants.MeetingEndedSync.html" class="tsd-kind-type-alias">MeetingEndedSync</a>.
|
|
307
309
|
If the user was a participant in the meeting, users will receive <a href="../enums/constants.RoomEvent.html#EVICTED" class="tsd-kind-enum-member">RoomEvent.EVICTED</a> with EvictedFromRoom.</p>
|
|
308
310
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">member</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">member</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>user will receive <a href="../enums/constants.SfuEvent.html#CHAT_DELETED" class="tsd-kind-enum-member">SfuEvent.CHAT_DELETED</a> with <a href="../types/constants.UserSpecificChatInfo.html" class="tsd-kind-type-alias">UserSpecificChatInfo</a>.</p>
|
|
309
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
311
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2291</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeMemberFromThread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Member<wbr/>From<wbr/>Thread</span><a href="#removeMemberFromThread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeMemberFromThread.removeMemberFromThread-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Member<wbr/>From<wbr/>Thread</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.RemovedMemberFromThread.html" class="tsd-signature-type tsd-kind-type-alias">RemovedMemberFromThread</a><span class="tsd-signature-symbol">></span><a href="#removeMemberFromThread.removeMemberFromThread-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove member from thread</p>
|
|
310
312
|
<p>For space owner/thread creator only</p>
|
|
311
313
|
<p>Thread members will receive <a href="../enums/constants.SpaceEvent.html#REMOVED_MEMBER_FROM_THREAD" class="tsd-kind-enum-member">SpaceEvent.REMOVED_MEMBER_FROM_THREAD</a> with <a href="../types/constants.RemovedMemberFromThread.html" class="tsd-kind-type-alias">RemovedMemberFromThread</a></p>
|
|
312
314
|
<p>The removed member will receive <a href="../enums/constants.SpaceEvent.html#SPACE_THREAD_DELETED" class="tsd-kind-enum-member">SpaceEvent.SPACE_THREAD_DELETED</a> with <a href="../types/constants.SpaceThreadDeleted.html" class="tsd-kind-type-alias">SpaceThreadDeleted</a></p>
|
|
313
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">member</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">threadId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">member</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">thread<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.RemovedMemberFromThread.html" class="tsd-signature-type tsd-kind-type-alias">RemovedMemberFromThread</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
315
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">member</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">threadId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">member</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">thread<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.RemovedMemberFromThread.html" class="tsd-signature-type tsd-kind-type-alias">RemovedMemberFromThread</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2967</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeReactionOnMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Reaction<wbr/>On<wbr/>Message</span><a href="#removeReactionOnMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeReactionOnMessage.removeReactionOnMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Reaction<wbr/>On<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedRemovedReactionOnMessage.html" class="tsd-signature-type tsd-kind-type-alias">AddedRemovedReactionOnMessage</a><span class="tsd-signature-symbol">></span><a href="#removeReactionOnMessage.removeReactionOnMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove reaction on message in a Direct chat | Channel | Thread</p>
|
|
314
316
|
<p>Members will receive <a href="../enums/constants.SfuEvent.html#REACTION_ON_MESSAGE_REMOVED" class="tsd-kind-enum-member">SfuEvent.REACTION_ON_MESSAGE_REMOVED</a> with <a href="../types/constants.AddedRemovedReactionOnMessage.html" class="tsd-kind-type-alias">AddedRemovedReactionOnMessage</a></p>
|
|
315
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">messageId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">reaction</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">message<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">reaction</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedRemovedReactionOnMessage.html" class="tsd-signature-type tsd-kind-type-alias">AddedRemovedReactionOnMessage</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
317
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">messageId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">reaction</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">message<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">reaction</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.AddedRemovedReactionOnMessage.html" class="tsd-signature-type tsd-kind-type-alias">AddedRemovedReactionOnMessage</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1331</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeRoleFromMember" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Role<wbr/>From<wbr/>Member</span><a href="#removeRoleFromMember" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeRoleFromMember.removeRoleFromMember-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Role<wbr/>From<wbr/>Member</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.RemovedRoleFromMember.html" class="tsd-signature-type tsd-kind-type-alias">RemovedRoleFromMember</a><span class="tsd-signature-symbol">></span><a href="#removeRoleFromMember.removeRoleFromMember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove space role from member</p>
|
|
316
318
|
<p>For space owner/user that has permission to manage roles</p>
|
|
317
319
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#REMOVED_ROLE_FROM_MEMBER" class="tsd-kind-enum-member">SpaceEvent.REMOVED_ROLE_FROM_MEMBER</a> with <a href="../types/constants.RemovedRoleFromMember.html" class="tsd-kind-type-alias">RemovedRoleFromMember</a></p>
|
|
318
320
|
<p>Participant from whom this role will be removed will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CHANNEL_DELETED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CHANNEL_DELETED</a> with <a href="../types/constants.SpaceChannelDeleted.html" class="tsd-kind-type-alias">SpaceChannelDeleted</a> for each channel they were part of because of this role.
|
|
319
321
|
Other members of these channels will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CHANNEL_UPDATED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CHANNEL_UPDATED</a> with <a href="../types/constants.SpaceChannelUpdated.html" class="tsd-kind-type-alias">SpaceChannelUpdated</a>.</p>
|
|
320
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">memberId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">roleId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">member<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">role<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.RemovedRoleFromMember.html" class="tsd-signature-type tsd-kind-type-alias">RemovedRoleFromMember</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
321
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
322
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">memberId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">roleId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">member<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">role<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.RemovedRoleFromMember.html" class="tsd-signature-type tsd-kind-type-alias">RemovedRoleFromMember</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3134</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>User</span><a href="#removeUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeUser.removeUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#removeUser.removeUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove user (internal using)</p>
|
|
323
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1108</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="renameChat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rename<wbr/>Chat</span><a href="#renameChat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="renameChat.renameChat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">rename<wbr/>Chat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#renameChat.renameChat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update chat</p>
|
|
322
324
|
<p>Chat members will receive <a href="../enums/constants.SfuEvent.html#CHAT_UPDATED" class="tsd-kind-enum-member">SfuEvent.CHAT_UPDATED</a> with <a href="../types/constants.UserSpecificChatInfo.html" class="tsd-kind-type-alias">UserSpecificChatInfo</a></p>
|
|
323
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
325
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2243</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resetPassword" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reset<wbr/>Password</span><a href="#resetPassword" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="resetPassword.resetPassword-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reset<wbr/>Password</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="reset_password_handler.ResetPasswordHandler.html" class="tsd-signature-type tsd-kind-class">ResetPasswordHandler</a><span class="tsd-signature-symbol">></span><a href="#resetPassword.resetPassword-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reset password</p>
|
|
324
326
|
<p>When calls, returns <a href="reset_password_handler.ResetPasswordHandler.html" class="tsd-kind-class">ResetPasswordHandler</a> then need to call <a href="reset_password_handler.ResetPasswordHandler.html#resetPassword" class="tsd-kind-method">ResetPasswordHandler.resetPassword</a> to reset the password</p>
|
|
325
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="reset_password_handler.ResetPasswordHandler.html" class="tsd-signature-type tsd-kind-class">ResetPasswordHandler</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
327
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="reset_password_handler.ResetPasswordHandler.html" class="tsd-signature-type tsd-kind-class">ResetPasswordHandler</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1006</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="revokeFriendInvite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>revoke<wbr/>Friend<wbr/>Invite</span><a href="#revokeFriendInvite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="revokeFriendInvite.revokeFriendInvite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">revoke<wbr/>Friend<wbr/>Invite</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">invite</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.FriendInviteDeleted.html" class="tsd-signature-type tsd-kind-type-alias">FriendInviteDeleted</a><span class="tsd-signature-symbol">></span><a href="#revokeFriendInvite.revokeFriendInvite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Revoke friend invite</p>
|
|
326
328
|
<p>Users will receive <a href="../enums/constants.SfuEvent.html#OUTGOING_FRIEND_INVITE_DELETED" class="tsd-kind-enum-member">SfuEvent.OUTGOING_FRIEND_INVITE_DELETED</a> and <a href="../enums/constants.SfuEvent.html#INCOMING_FRIEND_INVITE_DELETED" class="tsd-kind-enum-member">SfuEvent.INCOMING_FRIEND_INVITE_DELETED</a> with <a href="../types/constants.FriendInviteDeleted.html" class="tsd-kind-type-alias">FriendInviteDeleted</a>.</p>
|
|
327
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">invite</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">inviteId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">invite<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.FriendInviteDeleted.html" class="tsd-signature-type tsd-kind-type-alias">FriendInviteDeleted</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
328
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">inviteCode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">invite<wbr/>Code</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceInvite.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceInvite</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
329
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">invite</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">inviteId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">invite<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.FriendInviteDeleted.html" class="tsd-signature-type tsd-kind-type-alias">FriendInviteDeleted</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1718</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="revokeSpaceInvite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>revoke<wbr/>Space<wbr/>Invite</span><a href="#revokeSpaceInvite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="revokeSpaceInvite.revokeSpaceInvite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">revoke<wbr/>Space<wbr/>Invite</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceInvite.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceInvite</a><span class="tsd-signature-symbol">></span><a href="#revokeSpaceInvite.revokeSpaceInvite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removing the space invite</p>
|
|
330
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">inviteCode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">invite<wbr/>Code</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SfuSpaceInvite.html" class="tsd-signature-type tsd-kind-type-alias">SfuSpaceInvite</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2673</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="roomAvailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>room<wbr/>Available</span><a href="#roomAvailable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="roomAvailable.roomAvailable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">room<wbr/>Available</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span><a href="#roomAvailable.roomAvailable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check and get an available room.</p>
|
|
329
331
|
<p>To join, you need to use room.join()</p>
|
|
330
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pin</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">pin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
331
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pin</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">pin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2520</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="searchChatMessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">search<wbr/>Chat<wbr/>Messages</span><a href="#searchChatMessages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="searchChatMessages.searchChatMessages-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">search<wbr/>Chat<wbr/>Messages</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Message.html" class="tsd-signature-type tsd-kind-type-alias">Message</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#searchChatMessages.searchChatMessages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">chatId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">searchId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">searchString</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">chat<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">search<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">search<wbr/>String</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Message.html" class="tsd-signature-type tsd-kind-type-alias">Message</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2050</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="searchMessageAttachments" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">search<wbr/>Message<wbr/>Attachments</span><a href="#searchMessageAttachments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="searchMessageAttachments.searchMessageAttachments-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">search<wbr/>Message<wbr/>Attachments</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageAttachmentsSearchResult.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachmentsSearchResult</a><span class="tsd-signature-symbol">></span><a href="#searchMessageAttachments.searchMessageAttachments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">attachmentsType</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.MessageAttachmentMediaType.html" class="tsd-signature-type tsd-kind-enum">MessageAttachmentMediaType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">chatId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">searchString</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.SortOrder.html" class="tsd-signature-type tsd-kind-enum">SortOrder</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeFrame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">attachments<wbr/>Type</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.MessageAttachmentMediaType.html" class="tsd-signature-type tsd-kind-enum">MessageAttachmentMediaType</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">date<wbr/>Mark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">lower<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">upper<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">chat<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">search<wbr/>String</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">sort<wbr/>Order</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.SortOrder.html" class="tsd-signature-type tsd-kind-enum">SortOrder</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">time<wbr/>Frame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageAttachmentsSearchResult.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachmentsSearchResult</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2066</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message</span><a href="#sendMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sendMessage.sendMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageStatus.html" class="tsd-signature-type tsd-kind-type-alias">MessageStatus</a><span class="tsd-signature-symbol">></span><a href="#sendMessage.sendMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Send a message to a Direct chat | Channel | Thread</p>
|
|
332
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pin</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">pin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="room_extended.RoomExtended.html" class="tsd-signature-type tsd-kind-class">RoomExtended</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2520</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="roomExists" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>room<wbr/>Exists</span><a href="#roomExists" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="roomExists.roomExists-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">room<wbr/>Exists</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#roomExists.roomExists-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks for the existence of a running room.</p>
|
|
333
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pin</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">pin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2538</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="searchChatMessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">search<wbr/>Chat<wbr/>Messages</span><a href="#searchChatMessages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="searchChatMessages.searchChatMessages-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">search<wbr/>Chat<wbr/>Messages</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Message.html" class="tsd-signature-type tsd-kind-type-alias">Message</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#searchChatMessages.searchChatMessages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">chatId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">searchId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">searchString</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">chat<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">search<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">search<wbr/>String</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.Message.html" class="tsd-signature-type tsd-kind-type-alias">Message</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2065</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="searchMessageAttachments" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">search<wbr/>Message<wbr/>Attachments</span><a href="#searchMessageAttachments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="searchMessageAttachments.searchMessageAttachments-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">search<wbr/>Message<wbr/>Attachments</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageAttachmentsSearchResult.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachmentsSearchResult</a><span class="tsd-signature-symbol">></span><a href="#searchMessageAttachments.searchMessageAttachments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">attachmentsType</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.MessageAttachmentMediaType.html" class="tsd-signature-type tsd-kind-enum">MessageAttachmentMediaType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">chatId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">searchString</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.SortOrder.html" class="tsd-signature-type tsd-kind-enum">SortOrder</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeFrame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">attachments<wbr/>Type</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.MessageAttachmentMediaType.html" class="tsd-signature-type tsd-kind-enum">MessageAttachmentMediaType</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">boundaries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dateMark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">lowerLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">upperLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">date<wbr/>Mark</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">lower<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">upper<wbr/>Limit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">chat<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">search<wbr/>String</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">sort<wbr/>Order</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.SortOrder.html" class="tsd-signature-type tsd-kind-enum">SortOrder</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">time<wbr/>Frame</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageAttachmentsSearchResult.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachmentsSearchResult</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2081</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message</span><a href="#sendMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sendMessage.sendMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageStatus.html" class="tsd-signature-type tsd-kind-type-alias">MessageStatus</a><span class="tsd-signature-symbol">></span><a href="#sendMessage.sendMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Send a message to a Direct chat | Channel | Thread</p>
|
|
332
334
|
<p>Members will receive <a href="../enums/constants.SfuEvent.html#MESSAGE" class="tsd-kind-enum-member">SfuEvent.MESSAGE</a> with <a href="../types/constants.Message.html" class="tsd-kind-type-alias">Message</a></p>
|
|
333
335
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">attachments</span><span class="tsd-signature-symbol">?: </span><a href="../types/constants.MessageAttachment.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">parentId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityId</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetEntityType</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">to</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">attachments</span><span class="tsd-signature-symbol">?: </span><a href="../types/constants.MessageAttachment.html" class="tsd-signature-type tsd-kind-type-alias">MessageAttachment</a><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">parent<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>to send reply message</p>
|
|
334
336
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">: </span><a href="../types/constants.MessageTargetEntityId.html" class="tsd-signature-type tsd-kind-type-alias">MessageTargetEntityId</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">target<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.MessageTargetEntityType.html" class="tsd-signature-type tsd-kind-enum">MessageTargetEntityType</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">to</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>to send a private message</p>
|
|
335
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageStatus.html" class="tsd-signature-type tsd-kind-type-alias">MessageStatus</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
337
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.MessageStatus.html" class="tsd-signature-type tsd-kind-type-alias">MessageStatus</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1218</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="server" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>server</span><a href="#server" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="server.server-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">server</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#server.server-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3185</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="signUp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sign<wbr/>Up</span><a href="#signUp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="signUp.signUp-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sign<wbr/>Up</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SignUpStatus.html" class="tsd-signature-type tsd-kind-type-alias">SignUpStatus</a><span class="tsd-signature-symbol">></span><a href="#signUp.signUp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sign up for new users</p>
|
|
336
338
|
<p>Works in a separate connection</p>
|
|
337
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SignUpStatus.html" class="tsd-signature-type tsd-kind-type-alias">SignUpStatus</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
339
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SignUpStatus.html" class="tsd-signature-type tsd-kind-type-alias">SignUpStatus</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:872</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="state.state-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">state</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.State.html" class="tsd-signature-type tsd-kind-enum">State</a><a href="#state.state-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../enums/constants.State.html" class="tsd-signature-type tsd-kind-enum">State</a></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3189</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateActivityStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Activity<wbr/>Status</span><a href="#updateActivityStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateActivityStatus.updateActivityStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Activity<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">isActive</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updateActivityStatus.updateActivityStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update user activity</p>
|
|
338
340
|
<p>Working with selected <a href="../enums/constants.PresenceStatus.html#ONLINE" class="tsd-kind-enum-member">PresenceStatus.ONLINE</a> by <a href="sfu_extended.SfuExtended.html#updatePresenceStatus" class="tsd-kind-method">updatePresenceStatus</a>.
|
|
339
341
|
Does not work with other statuses.</p>
|
|
340
342
|
<p>The user client that called this method will receive <a href="../types/constants.UserInfoChangedEvent.html" class="tsd-kind-type-alias">UserInfoChangedEvent</a> with <a href="../enums/constants.PresenceStatus.html#ONLINE" class="tsd-kind-enum-member">PresenceStatus.ONLINE</a> or <a href="../enums/constants.PresenceStatus.html#IDLE" class="tsd-kind-enum-member">PresenceStatus.IDLE</a>.
|
|
@@ -345,15 +347,15 @@ If the user has other connected active clients then user contacts will not recei
|
|
|
345
347
|
<p>{@param isActive} = true:
|
|
346
348
|
If all user clients was inactive then user contacts will receive <a href="../types/constants.UserPresenceStatusUpdated.html" class="tsd-kind-type-alias">UserPresenceStatusUpdated</a> with <a href="../enums/constants.PresenceStatus.html#ONLINE" class="tsd-kind-enum-member">PresenceStatus.ONLINE</a>.
|
|
347
349
|
If the user has at least one active connected client, then the contacts will not receive any events.</p>
|
|
348
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">isActive</span>: <span class="tsd-signature-type">boolean</span></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
350
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">isActive</span>: <span class="tsd-signature-type">boolean</span></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2001</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateCalendarEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Calendar<wbr/>Event</span><a href="#updateCalendarEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateCalendarEvent.updateCalendarEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Calendar<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.CalendarEvent.html" class="tsd-signature-type tsd-kind-type-alias">CalendarEvent</a><span class="tsd-signature-symbol">></span><a href="#updateCalendarEvent.updateCalendarEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update calendar event</p>
|
|
349
351
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">accessCode</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">allowJoinAtAnyTime</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">ownerVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">participantVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">recurring</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useLocalAutoRecord</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useMuteAudioOnJoin</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">usePMI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">waitingRoom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">access<wbr/>Code</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">allow<wbr/>Join<wbr/>At<wbr/>Any<wbr/>Time</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">owner<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">participant<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">recurring</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Local<wbr/>Auto<wbr/>Record</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Mute<wbr/>Audio<wbr/>On<wbr/>Join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">usePMI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>if true then user PMI settings will be updated and user will receive <a href="../enums/constants.SfuEvent.html#UPDATE_USER_PMI_SETTINGS" class="tsd-kind-enum-member">SfuEvent.UPDATE_USER_PMI_SETTINGS</a> with <a href="../types/constants.UserPmiSettings.html" class="tsd-kind-type-alias">UserPmiSettings</a></p>
|
|
350
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">waiting<wbr/>Room</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.CalendarEvent.html" class="tsd-signature-type tsd-kind-type-alias">CalendarEvent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1809</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateChannelSendPolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">update<wbr/>Channel<wbr/>Send<wbr/>Policy</span><a href="#updateChannelSendPolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateChannelSendPolicy.updateChannelSendPolicy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Channel<wbr/>Send<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#updateChannelSendPolicy.updateChannelSendPolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">channel</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelSendPolicy</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Send<wbr/>Policy</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2287</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateChatConfiguration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">update<wbr/>Chat<wbr/>Configuration</span><a href="#updateChatConfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateChatConfiguration.updateChatConfiguration-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Chat<wbr/>Configuration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#updateChatConfiguration.updateChatConfiguration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">allowedToAddExternalUser</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">channelSendPolicy</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sendPermissionList</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChatType.html" class="tsd-signature-type tsd-kind-enum">ChatType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">allowed<wbr/>To<wbr/>Add<wbr/>External<wbr/>User</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">channel<wbr/>Send<wbr/>Policy</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">send<wbr/>Permission<wbr/>List</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChatType.html" class="tsd-signature-type tsd-kind-enum">ChatType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2352</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateChatReceivePolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Chat<wbr/>Receive<wbr/>Policy</span><a href="#updateChatReceivePolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateChatReceivePolicy.updateChatReceivePolicy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Chat<wbr/>Receive<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#updateChatReceivePolicy.updateChatReceivePolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">channel</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">chatReceivePolicy</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.ChatReceivePolicy.html" class="tsd-signature-type tsd-kind-enum">ChatReceivePolicy</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">chat<wbr/>Receive<wbr/>Policy</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.ChatReceivePolicy.html" class="tsd-signature-type tsd-kind-enum">ChatReceivePolicy</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2301</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updatePresenceStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Presence<wbr/>Status</span><a href="#updatePresenceStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updatePresenceStatus.updatePresenceStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Presence<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updatePresenceStatus.updatePresenceStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update presence status</p>
|
|
352
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">waiting<wbr/>Room</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.CalendarEvent.html" class="tsd-signature-type tsd-kind-type-alias">CalendarEvent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1824</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateChannelSendPolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">update<wbr/>Channel<wbr/>Send<wbr/>Policy</span><a href="#updateChannelSendPolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateChannelSendPolicy.updateChannelSendPolicy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Channel<wbr/>Send<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#updateChannelSendPolicy.updateChannelSendPolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">channel</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelSendPolicy</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Send<wbr/>Policy</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2305</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateChatConfiguration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">update<wbr/>Chat<wbr/>Configuration</span><a href="#updateChatConfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateChatConfiguration.updateChatConfiguration-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Chat<wbr/>Configuration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#updateChatConfiguration.updateChatConfiguration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">chat</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">allowedToAddExternalUser</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">channelSendPolicy</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sendPermissionList</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChatType.html" class="tsd-signature-type tsd-kind-enum">ChatType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">allowed<wbr/>To<wbr/>Add<wbr/>External<wbr/>User</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">channel<wbr/>Send<wbr/>Policy</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChannelSendPolicy.html" class="tsd-signature-type tsd-kind-enum">ChannelSendPolicy</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">send<wbr/>Permission<wbr/>List</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><a href="../enums/constants.ChatType.html" class="tsd-signature-type tsd-kind-enum">ChatType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2370</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateChatReceivePolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Chat<wbr/>Receive<wbr/>Policy</span><a href="#updateChatReceivePolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateChatReceivePolicy.updateChatReceivePolicy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Chat<wbr/>Receive<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span><a href="#updateChatReceivePolicy.updateChatReceivePolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">channel</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">chatReceivePolicy</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.ChatReceivePolicy.html" class="tsd-signature-type tsd-kind-enum">ChatReceivePolicy</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">id</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">chat<wbr/>Receive<wbr/>Policy</span><span class="tsd-signature-symbol">: </span><a href="../enums/constants.ChatReceivePolicy.html" class="tsd-signature-type tsd-kind-enum">ChatReceivePolicy</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserSpecificChatInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserSpecificChatInfo</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2319</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updatePresenceStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Presence<wbr/>Status</span><a href="#updatePresenceStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updatePresenceStatus.updatePresenceStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Presence<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updatePresenceStatus.updatePresenceStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update presence status</p>
|
|
351
353
|
<p>Friends and users with whom there are mutual space channels or direct chats will receive <a href="../enums/constants.SfuEvent.html#USER_PRESENCE_STATUS_UPDATED" class="tsd-kind-enum-member">SfuEvent.USER_PRESENCE_STATUS_UPDATED</a> with <a href="../types/constants.UserPresenceStatusUpdated.html" class="tsd-kind-type-alias">UserPresenceStatusUpdated</a>.
|
|
352
354
|
The selected status is saved and will persist across subsequent connects. It can be retrieved using the <a href="sfu_extended.SfuExtended.html#getUserInfo" class="tsd-kind-method">getUserInfo</a>.</p>
|
|
353
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">status</span>: <a href="../enums/constants.PresenceStatus.html" class="tsd-signature-type tsd-kind-enum">PresenceStatus</a></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
355
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">status</span>: <a href="../enums/constants.PresenceStatus.html" class="tsd-signature-type tsd-kind-enum">PresenceStatus</a></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1974</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateSpaceCategory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Space<wbr/>Category</span><a href="#updateSpaceCategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateSpaceCategory.updateSpaceCategory-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Space<wbr/>Category</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updateSpaceCategory.updateSpaceCategory-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete space category</p>
|
|
354
356
|
<p>For space owner/category creator/user that has permission to manage categories</p>
|
|
355
357
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CATEGORY_UPDATED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CATEGORY_UPDATED</a> with <a href="../types/constants.SpaceCategoryUpdated.html" class="tsd-kind-type-alias">SpaceCategoryUpdated</a></p>
|
|
356
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">categoryId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">category<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
358
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">categoryId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">category<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2754</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateSpaceChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Space<wbr/>Channel</span><a href="#updateSpaceChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateSpaceChannel.updateSpaceChannel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Space<wbr/>Channel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceChannelUpdated.html" class="tsd-signature-type tsd-kind-type-alias">SpaceChannelUpdated</a><span class="tsd-signature-symbol">></span><a href="#updateSpaceChannel.updateSpaceChannel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update space channel</p>
|
|
357
359
|
<p>For space owner/user that has permission to manage channels</p>
|
|
358
360
|
<p>Channel members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CHANNEL_UPDATED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CHANNEL_UPDATED</a> with <a href="../types/constants.SpaceChannelUpdated.html" class="tsd-kind-type-alias">SpaceChannelUpdated</a>
|
|
359
361
|
In the private channel added members will receive <a href="../enums/constants.SpaceEvent.html#NEW_SPACE_CHANNEL" class="tsd-kind-enum-member">SpaceEvent.NEW_SPACE_CHANNEL</a> with <a href="../types/constants.NewSpaceChannelEvent.html" class="tsd-kind-type-alias">NewSpaceChannelEvent</a>.
|
|
@@ -363,9 +365,14 @@ If the channel meeting was started, deleted members will receive <a href="../enu
|
|
|
363
365
|
If the deleted user was a participant in the meeting, users will receive <a href="../enums/constants.RoomEvent.html#EVICTED" class="tsd-kind-enum-member">RoomEvent.EVICTED</a> with EvictedFromRoom.</p>
|
|
364
366
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">channel</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isPrivate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">roles</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">is<wbr/>Private</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>used to create a private channel. Array of member ids or empty array.</p>
|
|
365
367
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">roles</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>used to create a private channel. Array of role ids or empty array.</p>
|
|
366
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceChannelUpdated.html" class="tsd-signature-type tsd-kind-type-alias">SpaceChannelUpdated</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
368
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceChannelUpdated.html" class="tsd-signature-type tsd-kind-type-alias">SpaceChannelUpdated</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2818</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateSpaceNickname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Space<wbr/>Nickname</span><a href="#updateSpaceNickname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateSpaceNickname.updateSpaceNickname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Space<wbr/>Nickname</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updateSpaceNickname.updateSpaceNickname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update nickname in the space</p>
|
|
369
|
+
<p>A custom nickname takes higher priority over the global one in a space. The nickname is updated for the SfuSpaceMember.
|
|
370
|
+
If a custom nickname is not set, it will be an empty string, and in this case, the display global nickname will be taken from the contacts.
|
|
371
|
+
To remove a custom nickname and use the global one, provide an empty string.</p>
|
|
372
|
+
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#USER_SPACE_NICKNAME_UPDATED" class="tsd-kind-enum-member">SpaceEvent.USER_SPACE_NICKNAME_UPDATED</a> with <a href="../types/constants.UserSpaceNicknameUpdated.html" class="tsd-kind-type-alias">UserSpaceNicknameUpdated</a></p>
|
|
373
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3167</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateSpaceOverview" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Space<wbr/>Overview</span><a href="#updateSpaceOverview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateSpaceOverview.updateSpaceOverview-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Space<wbr/>Overview</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">space</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updateSpaceOverview.updateSpaceOverview-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update space overview</p>
|
|
367
374
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_OVERVIEW_UPDATED" class="tsd-kind-enum-member">SpaceEvent.SPACE_OVERVIEW_UPDATED</a> with <a href="../types/constants.SpaceOverviewUpdated.html" class="tsd-kind-type-alias">SpaceOverviewUpdated</a></p>
|
|
368
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">space</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
375
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">space</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2595</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateSpaceRole" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Space<wbr/>Role</span><a href="#updateSpaceRole" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateSpaceRole.updateSpaceRole-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Space<wbr/>Role</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">role</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceRoleUpdated.html" class="tsd-signature-type tsd-kind-type-alias">SpaceRoleUpdated</a><span class="tsd-signature-symbol">></span><a href="#updateSpaceRole.updateSpaceRole-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update space role</p>
|
|
369
376
|
<p>For space owner/user that has permission to manage roles</p>
|
|
370
377
|
<p>Space members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_ROLE_UPDATED" class="tsd-kind-enum-member">SpaceEvent.SPACE_ROLE_UPDATED</a> with <a href="../types/constants.SpaceRoleUpdated.html" class="tsd-kind-type-alias">SpaceRoleUpdated</a></p>
|
|
371
378
|
<p>On the client side, a new role must be added to the participants listed in the SpaceRoleUpdated.membersForAddRole
|
|
@@ -373,11 +380,11 @@ and must be removed from participants listed in the SpaceRoleUpdated.membersForD
|
|
|
373
380
|
<p>Participants from whom this role will be removed will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CHANNEL_DELETED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CHANNEL_DELETED</a> with <a href="../types/constants.SpaceChannelDeleted.html" class="tsd-kind-type-alias">SpaceChannelDeleted</a> for each channel they were part of because of this role.</p>
|
|
374
381
|
<p>Participants who are assigned this role will receive <a href="../enums/constants.SpaceEvent.html#NEW_SPACE_CHANNEL" class="tsd-kind-enum-member">SpaceEvent.NEW_SPACE_CHANNEL</a> with <a href="../types/constants.NewSpaceChannelEvent.html" class="tsd-kind-type-alias">NewSpaceChannelEvent</a> for each channel that has this role in its access rights.</p>
|
|
375
382
|
<p>Participants who had the role before the update and still have it afterward will receive <a href="../enums/constants.SpaceEvent.html#SPACE_CHANNEL_UPDATED" class="tsd-kind-enum-member">SpaceEvent.SPACE_CHANNEL_UPDATED</a> with <a href="../types/constants.SpaceChannelUpdated.html" class="tsd-kind-type-alias">SpaceChannelUpdated</a> for each channel that has this role in its access rights.</p>
|
|
376
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">role</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">permissions</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">roleId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">permissions</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">role<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceRoleUpdated.html" class="tsd-signature-type tsd-kind-type-alias">SpaceRoleUpdated</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
383
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">role</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">permissions</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">roleId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">members</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">permissions</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">role<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.SpaceRoleUpdated.html" class="tsd-signature-type tsd-kind-type-alias">SpaceRoleUpdated</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3053</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateSpaceThread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Space<wbr/>Thread</span><a href="#updateSpaceThread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateSpaceThread.updateSpaceThread-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Space<wbr/>Thread</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updateSpaceThread.updateSpaceThread-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update space thread</p>
|
|
377
384
|
<p>For space owner/thread creator</p>
|
|
378
385
|
<p>Thread members will receive <a href="../enums/constants.SpaceEvent.html#SPACE_THREAD_UPDATED" class="tsd-kind-enum-member">SpaceEvent.SPACE_THREAD_UPDATED</a> with <a href="../types/constants.SpaceThreadUpdated.html" class="tsd-kind-type-alias">SpaceThreadUpdated</a></p>
|
|
379
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">threadId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">thread<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:
|
|
380
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">settings</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">accessCode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">allowJoinAtAnyTime</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useAccessCode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useLocalAutoRecord</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useMuteAudioOnJoin</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useOwnerVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useParticipantsVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useWaitingRoom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">access<wbr/>Code</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">allow<wbr/>Join<wbr/>At<wbr/>Any<wbr/>Time</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Access<wbr/>Code</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Local<wbr/>Auto<wbr/>Record</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Mute<wbr/>Audio<wbr/>On<wbr/>Join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Owner<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Participants<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Waiting<wbr/>Room</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserPmiSettings.html" class="tsd-signature-type tsd-kind-type-alias">UserPmiSettings</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1850</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="user" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="user.user-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">user</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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><a href="#user.user-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">auth<wbr/>Token</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3140</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromUTF8ArrayToStr" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>fromUTF8<wbr/>Array<wbr/>To<wbr/>Str</span><a href="#fromUTF8ArrayToStr" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromUTF8ArrayToStr.fromUTF8ArrayToStr-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fromUTF8<wbr/>Array<wbr/>To<wbr/>Str</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#fromUTF8ArrayToStr.fromUTF8ArrayToStr-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">data</span>: <span class="tsd-signature-type">Uint8Array</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3250</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="generateAttachmentId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>generate<wbr/>Attachment<wbr/>Id</span><a href="#generateAttachmentId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="generateAttachmentId.generateAttachmentId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>Attachment<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#generateAttachmentId.generateAttachmentId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This method is recommended for using to generate attachment id before sending.
|
|
386
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">threadId</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">space<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">thread<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:2914</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateUserPmiSettings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>User<wbr/>Pmi<wbr/>Settings</span><a href="#updateUserPmiSettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateUserPmiSettings.updateUserPmiSettings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>User<wbr/>Pmi<wbr/>Settings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">settings</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserPmiSettings.html" class="tsd-signature-type tsd-kind-type-alias">UserPmiSettings</a><span class="tsd-signature-symbol">></span><a href="#updateUserPmiSettings.updateUserPmiSettings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update user pmi settings</p>
|
|
387
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">settings</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">accessCode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">allowJoinAtAnyTime</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useAccessCode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useLocalAutoRecord</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useMuteAudioOnJoin</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useOwnerVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useParticipantsVideo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useWaitingRoom</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">access<wbr/>Code</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">allow<wbr/>Join<wbr/>At<wbr/>Any<wbr/>Time</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Access<wbr/>Code</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Local<wbr/>Auto<wbr/>Record</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Mute<wbr/>Audio<wbr/>On<wbr/>Join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Owner<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Participants<wbr/>Video</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Waiting<wbr/>Room</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/constants.UserPmiSettings.html" class="tsd-signature-type tsd-kind-type-alias">UserPmiSettings</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1865</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="user" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="user.user-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">user</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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><a href="#user.user-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">username</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></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">auth<wbr/>Token</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">nickname</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pmi</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3181</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromUTF8ArrayToStr" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>fromUTF8<wbr/>Array<wbr/>To<wbr/>Str</span><a href="#fromUTF8ArrayToStr" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromUTF8ArrayToStr.fromUTF8ArrayToStr-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fromUTF8<wbr/>Array<wbr/>To<wbr/>Str</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#fromUTF8ArrayToStr.fromUTF8ArrayToStr-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">data</span>: <span class="tsd-signature-type">Uint8Array</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3291</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="generateAttachmentId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>generate<wbr/>Attachment<wbr/>Id</span><a href="#generateAttachmentId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="generateAttachmentId.generateAttachmentId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>Attachment<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#generateAttachmentId.generateAttachmentId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This method is recommended for using to generate attachment id before sending.
|
|
381
388
|
Sending and downloading attachments may not work with other generating options.</p>
|
|
382
389
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>string of 36 ASCII characters</p>
|
|
383
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1453</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="strToUTF8Array" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>str<wbr/>ToUTF8<wbr/>Array</span><a href="#strToUTF8Array" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="strToUTF8Array.strToUTF8Array-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">str<wbr/>ToUTF8<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#strToUTF8Array.strToUTF8Array-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3226</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#__server" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>server</span></a><a href="#__state" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>state</span></a><a href="#__url" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>url</span></a><a href="#__user" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>user</span></a><a href="#_attachmentsTransferManager" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#attachments<wbr/>Transfer<wbr/>Manager</span></a><a href="#_binaryChunkSize" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#binary<wbr/>Chunk<wbr/>Size</span></a><a href="#_connection" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#connection</span></a><a href="#_logger" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#logger</span></a><a href="#_loggerPrefix" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#logger<wbr/>Prefix</span></a><a href="#_notifier" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#notifier</span></a><a href="#_resetPasswordId" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#reset<wbr/>Password<wbr/>Id</span></a><a href="#_rooms" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#rooms</span></a><a href="#_signUpId" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#sign<wbr/>Up<wbr/>Id</span></a><a href="#_uploadingAttachmentState" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#uploading<wbr/>Attachment<wbr/>State</span></a><a href="#_checkAuthenticated" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#check<wbr/>Authenticated</span></a><a href="#_createConnection" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#create<wbr/>Connection</span></a><a href="#_emmitAction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#emmit<wbr/>Action</span></a><a href="#_emmitBinaryAction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#emmit<wbr/>Binary<wbr/>Action</span></a><a href="#_getConnectionConfigForAnonymousUser" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Anonymous<wbr/>User</span></a><a href="#_getConnectionConfigForExamples" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Examples</span></a><a href="#acceptFriendInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>accept<wbr/>Friend<wbr/>Invite</span></a><a href="#addCalendarEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Calendar<wbr/>Event</span></a><a href="#addChannelSendPermissionListMember" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Channel<wbr/>Send<wbr/>Permission<wbr/>List<wbr/>Member</span></a><a href="#addChatToFavourites" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Chat<wbr/>To<wbr/>Favourites</span></a><a href="#addFriend" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Friend</span></a><a href="#addMemberToChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Member<wbr/>To<wbr/>Chat</span></a><a href="#addMembersToThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Members<wbr/>To<wbr/>Thread</span></a><a href="#addReactionOnMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Reaction<wbr/>On<wbr/>Message</span></a><a href="#addRoleToMember" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Role<wbr/>To<wbr/>Member</span></a><a href="#addSpaceRole" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Space<wbr/>Role</span></a><a href="#addUserEncryptionInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>User<wbr/>Encryption<wbr/>Info</span></a><a href="#changeUserEmail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Email</span></a><a href="#changeUserHostKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Host<wbr/>Key</span></a><a href="#changeUserNickname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Nickname</span></a><a href="#changeUserPassword" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Password</span></a><a href="#changeUserPhoneNumber" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Phone<wbr/>Number</span></a><a href="#changeUserTimezone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Timezone</span></a><a href="#closePcAndFireEvent" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close<wbr/>Pc<wbr/>And<wbr/>Fire<wbr/>Event</span></a><a href="#connect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect</span></a><a href="#createChannelMeeting" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Channel<wbr/>Meeting</span></a><a href="#createChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Chat</span></a><a href="#createDirectMeeting" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Direct<wbr/>Meeting</span></a><a href="#createRoom" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Room</span></a><a href="#createRoomFromEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Room<wbr/>From<wbr/>Event</span></a><a href="#createSpace" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Space</span></a><a href="#createSpaceCategory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Space<wbr/>Category</span></a><a href="#createSpaceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Space<wbr/>Channel</span></a><a href="#createSpaceThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Space<wbr/>Thread</span></a><a href="#deleteChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Chat</span></a><a href="#deleteMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Message</span></a><a href="#deleteSpace" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space</span></a><a href="#deleteSpaceCategory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space<wbr/>Category</span></a><a href="#deleteSpaceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space<wbr/>Channel</span></a><a href="#deleteSpaceRole" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space<wbr/>Role</span></a><a href="#deleteSpaceThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space<wbr/>Thread</span></a><a href="#disconnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disconnect</span></a><a href="#downloadAttachment" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>Attachment</span></a><a href="#editMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Message</span></a><a href="#ensureUsernameAvailable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ensure<wbr/>Username<wbr/>Available</span></a><a href="#generateNewSpaceInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>New<wbr/>Space<wbr/>Invite</span></a><a href="#getContacts" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Contacts</span></a><a href="#getExamplesFreeUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Examples<wbr/>Free<wbr/>User</span></a><a href="#getFirstAndLastMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>First<wbr/>And<wbr/>Last<wbr/>Message</span></a><a href="#getMessageAttachment" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Message<wbr/>Attachment</span></a><a href="#getMessagesCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Messages<wbr/>Count</span></a><a href="#getPublicChannels" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Public<wbr/>Channels</span></a><a href="#getRolePermissions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Role<wbr/>Permissions</span></a><a href="#getRoom" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Room</span></a><a href="#getSendingAttachmentsHandler" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sending<wbr/>Attachments<wbr/>Handler</span></a><a href="#getUnreadMessagesCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Unread<wbr/>Messages<wbr/>Count</span></a><a href="#getUserCalendar" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Calendar</span></a><a href="#getUserChats" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Chats</span></a><a href="#getUserEncryptionInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Encryption<wbr/>Info</span></a><a href="#getUserInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Info</span></a><a href="#getUserPmiSettings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Pmi<wbr/>Settings</span></a><a href="#getUserSpaces" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Spaces</span></a><a href="#joinSpaceByInviteCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>join<wbr/>Space<wbr/>By<wbr/>Invite<wbr/>Code</span></a><a href="#leaveSpace" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Space</span></a><a href="#loadActiveRooms" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Active<wbr/>Rooms</span></a><a href="#loadChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Chat</span></a><a href="#loadMessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Messages</span></a><a href="#loadMessagesWithMentions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Messages<wbr/>With<wbr/>Mentions</span></a><a href="#logout" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>logout</span></a><a href="#markMessageRead" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark<wbr/>Message<wbr/>Read</span></a><a href="#markMessageUnread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark<wbr/>Message<wbr/>Unread</span></a><a href="#moveSpaceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Space<wbr/>Channel</span></a><a href="#off" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a><a href="#on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#rejectFriendInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reject<wbr/>Friend<wbr/>Invite</span></a><a href="#removeCalendarEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Calendar<wbr/>Event</span></a><a href="#removeChannelSendPermissionListMember" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Channel<wbr/>Send<wbr/>Permission<wbr/>List<wbr/>Member</span></a><a href="#removeChatFromFavourites" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Chat<wbr/>From<wbr/>Favourites</span></a><a href="#removeFriend" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Friend</span></a><a href="#removeMemberFromChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Member<wbr/>From<wbr/>Chat</span></a><a href="#removeMemberFromThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Member<wbr/>From<wbr/>Thread</span></a><a href="#removeReactionOnMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Reaction<wbr/>On<wbr/>Message</span></a><a href="#removeRoleFromMember" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Role<wbr/>From<wbr/>Member</span></a><a href="#removeUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>User</span></a><a href="#renameChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rename<wbr/>Chat</span></a><a href="#resetPassword" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Password</span></a><a href="#revokeFriendInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>revoke<wbr/>Friend<wbr/>Invite</span></a><a href="#revokeSpaceInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>revoke<wbr/>Space<wbr/>Invite</span></a><a href="#roomAvailable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>room<wbr/>Available</span></a><a href="#roomExists" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>room<wbr/>Exists</span></a><a href="#searchChatMessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search<wbr/>Chat<wbr/>Messages</span></a><a href="#searchMessageAttachments" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search<wbr/>Message<wbr/>Attachments</span></a><a href="#sendMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message</span></a><a href="#server" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>server</span></a><a href="#signUp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>Up</span></a><a href="#state" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>state</span></a><a href="#updateActivityStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Activity<wbr/>Status</span></a><a href="#updateCalendarEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Calendar<wbr/>Event</span></a><a href="#updateChannelSendPolicy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Channel<wbr/>Send<wbr/>Policy</span></a><a href="#updateChatConfiguration" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Chat<wbr/>Configuration</span></a><a href="#updateChatReceivePolicy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Chat<wbr/>Receive<wbr/>Policy</span></a><a href="#updatePresenceStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Presence<wbr/>Status</span></a><a href="#updateSpaceCategory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Category</span></a><a href="#updateSpaceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Channel</span></a><a href="#updateSpaceOverview" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Overview</span></a><a href="#updateSpaceRole" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Role</span></a><a href="#updateSpaceThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Thread</span></a><a href="#updateUserPmiSettings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>User<wbr/>Pmi<wbr/>Settings</span></a><a href="#user" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>user</span></a><a href="#fromUTF8ArrayToStr" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fromUTF8<wbr/>Array<wbr/>To<wbr/>Str</span></a><a href="#generateAttachmentId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Attachment<wbr/>Id</span></a><a href="#strToUTF8Array" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>str<wbr/>ToUTF8<wbr/>Array</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@flashphoner/sfusdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|
|
390
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:1468</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="strToUTF8Array" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>str<wbr/>ToUTF8<wbr/>Array</span><a href="#strToUTF8Array" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="strToUTF8Array.strToUTF8Array-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">str<wbr/>ToUTF8<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#strToUTF8Array.strToUTF8Array-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in sfu-extended.ts:3267</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#__server" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>server</span></a><a href="#__state" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>state</span></a><a href="#__url" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>url</span></a><a href="#__user" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#_<wbr/>user</span></a><a href="#_attachmentsTransferManager" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#attachments<wbr/>Transfer<wbr/>Manager</span></a><a href="#_binaryChunkSize" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#binary<wbr/>Chunk<wbr/>Size</span></a><a href="#_connection" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#connection</span></a><a href="#_logger" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#logger</span></a><a href="#_loggerPrefix" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#logger<wbr/>Prefix</span></a><a href="#_notifier" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#notifier</span></a><a href="#_resetPasswordId" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#reset<wbr/>Password<wbr/>Id</span></a><a href="#_rooms" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#rooms</span></a><a href="#_signUpId" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#sign<wbr/>Up<wbr/>Id</span></a><a href="#_uploadingAttachmentState" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>#uploading<wbr/>Attachment<wbr/>State</span></a><a href="#_checkAuthenticated" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#check<wbr/>Authenticated</span></a><a href="#_createConnection" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#create<wbr/>Connection</span></a><a href="#_emmitAction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#emmit<wbr/>Action</span></a><a href="#_emmitBinaryAction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#emmit<wbr/>Binary<wbr/>Action</span></a><a href="#_getConnectionConfigForAnonymousUser" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Anonymous<wbr/>User</span></a><a href="#_getConnectionConfigForExamples" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>#get<wbr/>Connection<wbr/>Config<wbr/>For<wbr/>Examples</span></a><a href="#acceptFriendInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>accept<wbr/>Friend<wbr/>Invite</span></a><a href="#addCalendarEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Calendar<wbr/>Event</span></a><a href="#addChannelSendPermissionListMember" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Channel<wbr/>Send<wbr/>Permission<wbr/>List<wbr/>Member</span></a><a href="#addChatToFavourites" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Chat<wbr/>To<wbr/>Favourites</span></a><a href="#addFriend" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Friend</span></a><a href="#addMemberToChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Member<wbr/>To<wbr/>Chat</span></a><a href="#addMembersToThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Members<wbr/>To<wbr/>Thread</span></a><a href="#addReactionOnMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Reaction<wbr/>On<wbr/>Message</span></a><a href="#addRoleToMember" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Role<wbr/>To<wbr/>Member</span></a><a href="#addSpaceRole" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Space<wbr/>Role</span></a><a href="#addUserEncryptionInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>User<wbr/>Encryption<wbr/>Info</span></a><a href="#changeUserEmail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Email</span></a><a href="#changeUserHostKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Host<wbr/>Key</span></a><a href="#changeUserNickname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Nickname</span></a><a href="#changeUserPassword" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Password</span></a><a href="#changeUserPhoneNumber" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Phone<wbr/>Number</span></a><a href="#changeUserTimezone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>User<wbr/>Timezone</span></a><a href="#closePcAndFireEvent" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close<wbr/>Pc<wbr/>And<wbr/>Fire<wbr/>Event</span></a><a href="#connect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect</span></a><a href="#createChannelMeeting" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Channel<wbr/>Meeting</span></a><a href="#createChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Chat</span></a><a href="#createDirectMeeting" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Direct<wbr/>Meeting</span></a><a href="#createRoom" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Room</span></a><a href="#createRoomFromEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Room<wbr/>From<wbr/>Event</span></a><a href="#createSpace" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Space</span></a><a href="#createSpaceCategory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Space<wbr/>Category</span></a><a href="#createSpaceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Space<wbr/>Channel</span></a><a href="#createSpaceThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Space<wbr/>Thread</span></a><a href="#deleteChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Chat</span></a><a href="#deleteMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Message</span></a><a href="#deleteSpace" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space</span></a><a href="#deleteSpaceCategory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space<wbr/>Category</span></a><a href="#deleteSpaceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space<wbr/>Channel</span></a><a href="#deleteSpaceRole" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space<wbr/>Role</span></a><a href="#deleteSpaceThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Space<wbr/>Thread</span></a><a href="#disconnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disconnect</span></a><a href="#downloadAttachment" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>Attachment</span></a><a href="#editMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Message</span></a><a href="#ensureUsernameAvailable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ensure<wbr/>Username<wbr/>Available</span></a><a href="#generateNewSpaceInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>New<wbr/>Space<wbr/>Invite</span></a><a href="#getContacts" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Contacts</span></a><a href="#getExamplesFreeUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Examples<wbr/>Free<wbr/>User</span></a><a href="#getFirstAndLastMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>First<wbr/>And<wbr/>Last<wbr/>Message</span></a><a href="#getMessageAttachment" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Message<wbr/>Attachment</span></a><a href="#getMessagesCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Messages<wbr/>Count</span></a><a href="#getPublicChannels" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Public<wbr/>Channels</span></a><a href="#getRolePermissions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Role<wbr/>Permissions</span></a><a href="#getRoom" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Room</span></a><a href="#getSendingAttachmentsHandler" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sending<wbr/>Attachments<wbr/>Handler</span></a><a href="#getUnreadMessagesCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Unread<wbr/>Messages<wbr/>Count</span></a><a href="#getUserCalendar" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Calendar</span></a><a href="#getUserChats" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Chats</span></a><a href="#getUserEncryptionInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Encryption<wbr/>Info</span></a><a href="#getUserInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Info</span></a><a href="#getUserPmiSettings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Pmi<wbr/>Settings</span></a><a href="#getUserSpaces" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Spaces</span></a><a href="#joinSpaceByInviteCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>join<wbr/>Space<wbr/>By<wbr/>Invite<wbr/>Code</span></a><a href="#leaveSpace" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Space</span></a><a href="#loadActiveRooms" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Active<wbr/>Rooms</span></a><a href="#loadChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Chat</span></a><a href="#loadMessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Messages</span></a><a href="#loadMessagesWithMentions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Messages<wbr/>With<wbr/>Mentions</span></a><a href="#logout" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>logout</span></a><a href="#markMessageRead" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark<wbr/>Message<wbr/>Read</span></a><a href="#markMessageUnread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark<wbr/>Message<wbr/>Unread</span></a><a href="#moveSpaceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Space<wbr/>Channel</span></a><a href="#off" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a><a href="#on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#rejectFriendInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reject<wbr/>Friend<wbr/>Invite</span></a><a href="#removeCalendarEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Calendar<wbr/>Event</span></a><a href="#removeChannelSendPermissionListMember" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Channel<wbr/>Send<wbr/>Permission<wbr/>List<wbr/>Member</span></a><a href="#removeChatFromFavourites" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Chat<wbr/>From<wbr/>Favourites</span></a><a href="#removeFriend" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Friend</span></a><a href="#removeMemberFromChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Member<wbr/>From<wbr/>Chat</span></a><a href="#removeMemberFromThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Member<wbr/>From<wbr/>Thread</span></a><a href="#removeReactionOnMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Reaction<wbr/>On<wbr/>Message</span></a><a href="#removeRoleFromMember" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Role<wbr/>From<wbr/>Member</span></a><a href="#removeUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>User</span></a><a href="#renameChat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rename<wbr/>Chat</span></a><a href="#resetPassword" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Password</span></a><a href="#revokeFriendInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>revoke<wbr/>Friend<wbr/>Invite</span></a><a href="#revokeSpaceInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>revoke<wbr/>Space<wbr/>Invite</span></a><a href="#roomAvailable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>room<wbr/>Available</span></a><a href="#roomExists" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>room<wbr/>Exists</span></a><a href="#searchChatMessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search<wbr/>Chat<wbr/>Messages</span></a><a href="#searchMessageAttachments" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search<wbr/>Message<wbr/>Attachments</span></a><a href="#sendMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message</span></a><a href="#server" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>server</span></a><a href="#signUp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>Up</span></a><a href="#state" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>state</span></a><a href="#updateActivityStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Activity<wbr/>Status</span></a><a href="#updateCalendarEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Calendar<wbr/>Event</span></a><a href="#updateChannelSendPolicy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Channel<wbr/>Send<wbr/>Policy</span></a><a href="#updateChatConfiguration" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Chat<wbr/>Configuration</span></a><a href="#updateChatReceivePolicy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Chat<wbr/>Receive<wbr/>Policy</span></a><a href="#updatePresenceStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Presence<wbr/>Status</span></a><a href="#updateSpaceCategory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Category</span></a><a href="#updateSpaceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Channel</span></a><a href="#updateSpaceNickname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Nickname</span></a><a href="#updateSpaceOverview" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Overview</span></a><a href="#updateSpaceRole" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Role</span></a><a href="#updateSpaceThread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Space<wbr/>Thread</span></a><a href="#updateUserPmiSettings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>User<wbr/>Pmi<wbr/>Settings</span></a><a href="#user" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>user</span></a><a href="#fromUTF8ArrayToStr" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fromUTF8<wbr/>Array<wbr/>To<wbr/>Str</span></a><a href="#generateAttachmentId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Attachment<wbr/>Id</span></a><a href="#strToUTF8Array" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>str<wbr/>ToUTF8<wbr/>Array</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@flashphoner/sfusdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|