@flashphoner/sfusdk 2.0.277 → 2.0.279

package/dist/sdk/sfu-extended.d.ts

@@ -1,4 +1,4 @@
-import { AddedRoleToMember, Attachment, AttachmentRequest, AttachmentStatus, Calendar, CalendarEvent, SfuSpaceCategory, ChannelSendPolicy, Chat, ChatMap, ChatMessagesCount, ChatReceivePolicy, ChatType, ConnectionDetails, FirstAndLastChatMessage, InternalMessage, Invite, LastReadMessageUpdated, LoadMessagesWithMentionsResult, Message, MessageAttachment, MessageAttachmentData, MessageAttachmentMediaType, MessageAttachmentsSearchResult, MessageStatus, RoomInfo, SfuEvent, SignUpStatus, SortOrder, SfuSpace, SfuSpaceRole, State, User, UserEmail, UserHostKey, UserId, UserInfo, UserNickname, UserPassword, UserPhoneNumber, UserPmiSettings, UserSpecificChatInfo, UserTimezone, SfuSpaceInvite, SfuSpaceChannel, SpaceRoleDeleted, RemovedRoleFromMember, SfuSpaceThread, SpaceChannelUpdated, SfuSpaceRolePermissionSection, SpaceRoleUpdated, SpaceChannelMoved, SpaceEvent, MessageTargetEntityType, MessageTargetEntityId, UnreadMessagesCountEvent, MeetingSyncEvent } from "./constants";
+import { AddedRoleToMember, Attachment, AttachmentRequest, AttachmentStatus, Calendar, CalendarEvent, SfuSpaceCategory, ChannelSendPolicy, Chat, ChatMap, ChatMessagesCount, ChatReceivePolicy, ChatType, ConnectionDetails, FirstAndLastChatMessage, InternalMessage, Invite, LastReadMessageUpdated, LoadMessagesWithMentionsResult, Message, MessageAttachment, MessageAttachmentData, MessageAttachmentMediaType, MessageAttachmentsSearchResult, MessageStatus, RoomInfo, SfuEvent, SignUpStatus, SortOrder, SfuSpace, SfuSpaceRole, State, User, UserEmail, UserHostKey, UserId, UserInfo, UserNickname, UserPassword, UserPhoneNumber, UserPmiSettings, UserSpecificChatInfo, UserTimezone, SfuSpaceInvite, SfuSpaceChannel, SpaceRoleDeleted, RemovedRoleFromMember, SfuSpaceThread, SpaceChannelUpdated, SfuSpaceRolePermissionSection, SpaceRoleUpdated, SpaceChannelMoved, SpaceEvent, MessageTargetEntityType, MessageTargetEntityId, MeetingSyncEvent, UnreadMessagesCountEvent } from "./constants";
 import { RoomExtended } from "./room-extended";
 import { SendingAttachmentsHandler } from "./sending-attachments-handler";
 import { PrefixFunction, Verbosity } from "./logger";
@@ -8,6 +8,18 @@ declare type EventUnion = SfuEvent | SpaceEvent | MeetingSyncEvent;
 export declare class SfuExtended {
     #private;
     constructor(logLevel?: Verbosity, prefix?: PrefixFunction, log?: any);
+    /**
+     * Connects the user to the server.
+     *
+     * The user can connect using either a username and password or an authToken.
+     *
+     * Once the connection is successful, the {@link state} will change to {@link State.AUTHENTICATED}.
+     * After that, the sfu-sdk will emit the event {@link SfuEvent.CONNECTED}.
+     *
+     * @param options.username - The user's username (optional if `authToken` is provided).
+     * @param options.password - The user's password (optional if `authToken` is provided).
+     * @param options.authToken - The authentication token for direct login (optional if `username` and `password` are provided).
+     */
     connect(options: {
         url: string;
         username?: UserId;
@@ -27,23 +39,76 @@ export declare class SfuExtended {
         pmi: string;
         authToken: string;
     }>;
+    /**
+     * Method to disconnect from the server
+     *
+     * When disconnecting, user leaves all active rooms
+     *
+     * {@link state} changed to {@link State.DISCONNECTED | DISCONNECTED}
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Sign up for new users
+     *
+     * Works in a separate connection
+     */
     signUp(options: {
         url: string;
         timeout?: number;
         email: string;
         password: string;
     }): Promise<SignUpStatus>;
+    /**
+     * Reset password
+     *
+     * When calls, returns {@link ResetPasswordHandler} then need to call {@link ResetPasswordHandler.resetPassword} to reset the password
+     */
     resetPassword(options: {
         url: string;
         timeout?: number;
         email: string;
     }): Promise<ResetPasswordHandler>;
+    /**
+     * Remove user (internal using)
+     */
     removeUser(options: {
         url: string;
         timeout?: number;
         id: string;
     }): Promise<void>;
+    /**
+     * Logout from app
+     */
     logout(): Promise<LastReadMessageUpdated>;
+    /**
+     * Load messages for Direct chat | Channel | Thread
+     *
+     * @param params.timeFrame to load by start date to end date. For load all messages used with start = 0, end = -1.
+     * @param params.boundaries to load messages by specifying a particular message using its date,
+     * along with the number of messages above and below it. Upper limit includes message with date dateMark.
+     */
+    loadMessages(params: {
+        targetEntityType: MessageTargetEntityType;
+        targetEntityId: MessageTargetEntityId;
+        timeFrame?: {
+            start: number;
+            end: number;
+            limit?: number;
+        };
+        boundaries?: {
+            dateMark: number;
+            lowerLimit: number;
+            upperLimit: number;
+        };
+    }): Promise<Message[]>;
+    /**
+     * Send a message to a Direct chat | Channel | Thread
+     *
+     * Members will receive {@link SfuEvent.MESSAGE} with {@link Message}
+     *
+     * @param msg.parentId to send reply message
+     * @param msg.to to send a private message
+     */
     sendMessage(msg: {
         body?: string;
         to?: string;
@@ -53,43 +118,165 @@ export declare class SfuExtended {
         attachments?: Array<MessageAttachment>;
     }): Promise<MessageStatus>;
     /**
-     * This method is recommended for using to generate attachment id before sending.
-     * Sending and downloading attachments may not work with other generating options.
-     * @return string of 36 ASCII characters
-     **/
-    static generateAttachmentId(): string;
-    getSendingAttachmentsHandler(attachments: Array<MessageAttachmentData>, messageId: string): SendingAttachmentsHandler;
-    getMessageAttachment(attachment: AttachmentRequest): Promise<Attachment>;
+     * Edit a message in a Direct chat | Channel | Thread
+     *
+     * Members will receive {@link SfuEvent.CHAT_MESSAGE_EDITED} with {@link MessageEdited}
+     *
+     * @param msg.attachmentsToSend to add attachments to sent message
+     * @param msg.attachmentIdsToDelete to send a private message
+     */
+    editMessage(msg: {
+        targetEntityType: MessageTargetEntityType;
+        targetEntityId: MessageTargetEntityId;
+        messageId: string;
+        body: string;
+        attachmentsToSend?: Array<MessageAttachment>;
+        attachmentIdsToDelete?: string[];
+    }): Promise<MessageStatus>;
+    /**
+     * Delete a message in a Direct chat | Channel | Thread
+     *
+     * The message body will be changed to an empty string.
+     * The {@link Message.status} will be changed to {@link MessageState.DELETED}
+     *
+     * Attachments will be removed.
+     *
+     * Members will receive {@link SfuEvent.CHAT_MESSAGE_DELETED} with {@link MessageDeleted}
+     */
+    deleteMessage(msg: {
+        targetEntityType: MessageTargetEntityType;
+        targetEntityId: MessageTargetEntityId;
+        messageId: string;
+    }): Promise<void>;
+    /**
+     * Mark message as read in a Direct chat | Channel | Thread
+     *
+     * In targetEntity will change lastReadMessageId and lastReadMessageDate
+     *
+     * All unread messages with a {@link Message.date} earlier than or equal to the marked one will be marked as read.
+     * The sender of each message will receive {@link SfuEvent.UPDATE_MESSAGES_DELIVERY_STATUS}
+     * with {@link UpdateMessagesDeliveryStatusEvent} and {@link Message.deliveryStatus} will be changed at the server side to {@link DeliveryStatus.READ}.
+     */
     markMessageRead(msg: {
         id: string;
         targetEntityType: MessageTargetEntityType;
         targetEntityId: MessageTargetEntityId;
     }): Promise<LastReadMessageUpdated>;
+    /**
+     * Mark message as unread in a Direct chat | Channel | Thread
+     *
+     * In targetEntity will change lastReadMessageId and lastReadMessageDate. {@link Message.deliveryStatus}
+     *
+     * {@link Message.deliveryStatus} will not be changed at the server side. Senders will not receive events,
+     * however if the previous lastReadMessageDate is earlier than the updated value,
+     * the senders of those messages will receive {@link SfuEvent.UPDATE_MESSAGES_DELIVERY_STATUS}
+     * with {@link UpdateMessagesDeliveryStatusEvent} and {@link Message.deliveryStatus} will be changed at the server side to {@link DeliveryStatus.READ}.
+     */
     markMessageUnread(msg: {
         id: string;
         targetEntityType: MessageTargetEntityType;
         targetEntityId: MessageTargetEntityId;
     }): Promise<LastReadMessageUpdated>;
+    /**
+     * Get messages count in entity from {@link MessageTargetEntityType}
+     */
+    getMessagesCount(options: {
+        targetEntityType: MessageTargetEntityType;
+        targetEntityId: MessageTargetEntityId;
+    }): Promise<ChatMessagesCount>;
+    /**
+     * Get first message and last message in entity from {@link MessageTargetEntityType}
+     */
+    getFirstAndLastMessage(options: {
+        targetEntityType: MessageTargetEntityType;
+        targetEntityId: MessageTargetEntityId;
+    }): Promise<FirstAndLastChatMessage>;
+    /**
+     * Get count of unread messages in entity from {@link MessageTargetEntityType}
+     */
+    getUnreadMessagesCount(options: {
+        targetEntityType: MessageTargetEntityType;
+        targetEntityId: MessageTargetEntityId;
+    }): Promise<UnreadMessagesCountEvent>;
+    /**
+     * This method is recommended for using to generate attachment id before sending.
+     * Sending and downloading attachments may not work with other generating options.
+     * @return string of 36 ASCII characters
+     **/
+    static generateAttachmentId(): string;
+    /**
+     * Get handler for send or cancel sending attachments
+     *
+     * Can't cancel sent attachment
+     */
+    getSendingAttachmentsHandler(attachments: Array<MessageAttachmentData>, messageId: string): SendingAttachmentsHandler;
+    /**
+     * Load attachment from server
+     *
+     * On client side should receive {@link SfuEvent.MESSAGE_ATTACHMENT_STATE} with {@link AttachmentStatus} to show progress
+     */
+    getMessageAttachment(attachment: AttachmentRequest): Promise<Attachment>;
+    /**
+     * Get all users from server
+     */
     getUserList(): Promise<User[]>;
+    /**
+     * Invite user to contacts
+     *
+     * UserId must be passed if user exist. That user will receive {@link SfuEvent.CONTACT_INVITE} with {@link Invite}
+     *
+     * UserEmail must be passed if there is no such user yet. In this case user will be created at the server side with {@link UserState.PENDING_REGISTRATION} and default parameters
+     */
+    inviteContact(invite: {
+        to: UserId | UserEmail;
+    }): Promise<User>;
+    /**
+     * Add contact to favourites
+     *
+     * {@link User.favourite} will be changed to true at the server side
+     */
+    addContactToFavourites(contact: {
+        id: UserId;
+    }): Promise<User>;
+    /**
+     * Remove contact from favourites
+     *
+     * {@link User.favourite} will be changed to false at the server side
+     */
+    removeContactFromFavourites(contact: {
+        id: UserId;
+    }): Promise<User>;
+    /**
+     * Confirm contact
+     *
+     * {@link User.confirmed} will be changed to true for both users.
+     *
+     * @param invite.from - user with that userId will receive {@link SfuEvent.CONTACT_UPDATE} with {@link User}
+     */
+    confirmContact(invite: {
+        id: string;
+        from: UserId;
+        to: UserId;
+    }): Promise<User>;
+    /**
+     * Confirm contact
+     *
+     * {@link User.confirmed} will be changed to true for both users.
+     *
+     * @param contact.id - user with that userId will receive {@link SfuEvent.CONTACT_REMOVED} with {@link User}
+     */
+    removeContact(contact: {
+        id: UserId;
+    }): Promise<User>;
+    /**
+     * Get all user calendar events
+     */
     getUserCalendar(): Promise<Calendar>;
-    getUserPmiSettings(): Promise<UserPmiSettings>;
-    updateUserPmiSettings(settings: {
-        allowJoinAtAnyTime: boolean;
-        useMuteAudioOnJoin: boolean;
-        useLocalAutoRecord: boolean;
-        useAccessCode: boolean;
-        useWaitingRoom: boolean;
-        useOwnerVideo: boolean;
-        useParticipantsVideo: boolean;
-        accessCode: string;
-    }): Promise<UserPmiSettings>;
-    getUserInfo(): Promise<UserInfo>;
-    changeUserEmail(email: UserEmail): Promise<void>;
-    changeUserPassword(currentPassword: UserPassword, newPassword: UserPassword): Promise<void>;
-    changeUserNickname(nickname: UserNickname): Promise<void>;
-    changeUserPhoneNumber(phoneNumber: UserPhoneNumber): Promise<void>;
-    changeUserHostKey(hostKey: UserHostKey): Promise<void>;
-    changeUserTimezone(timezone: UserTimezone): Promise<void>;
+    /**
+     * Add calendar event
+     *
+     * @param event.usePMI - if true then user PMI settings will be updated and user will receive {@link SfuEvent.UPDATE_USER_PMI_SETTINGS} with {@link UserPmiSettings}
+     */
     addCalendarEvent(event: {
         title: string;
         description: string;
@@ -108,6 +295,11 @@ export declare class SfuExtended {
     removeCalendarEvent(event: {
         id: string;
     }): Promise<CalendarEvent>;
+    /**
+     * Update calendar event
+     *
+     * @param event.usePMI - if true then user PMI settings will be updated and user will receive {@link SfuEvent.UPDATE_USER_PMI_SETTINGS} with {@link UserPmiSettings}
+     */
     updateCalendarEvent(event: {
         id: string;
         title: string;
@@ -124,43 +316,63 @@ export declare class SfuExtended {
         useMuteAudioOnJoin: boolean;
         useLocalAutoRecord: boolean;
     }): Promise<CalendarEvent>;
-    getUserChats(): Promise<ChatMap>;
+    /**
+     * Get user pmi settings
+     *
+     * Used for create meetings
+     */
+    getUserPmiSettings(): Promise<UserPmiSettings>;
+    /**
+     * Update user pmi settings
+     */
+    updateUserPmiSettings(settings: {
+        allowJoinAtAnyTime: boolean;
+        useMuteAudioOnJoin: boolean;
+        useLocalAutoRecord: boolean;
+        useAccessCode: boolean;
+        useWaitingRoom: boolean;
+        useOwnerVideo: boolean;
+        useParticipantsVideo: boolean;
+        accessCode: string;
+    }): Promise<UserPmiSettings>;
+    /**
+     * Get user info
+     *
+     * Usually used to display profile info
+     */
+    getUserInfo(): Promise<UserInfo>;
+    /**
+     * Change user email
+     *
+     * Users will receive {@link SfuEvent.CONTACT_UPDATED} with changed email
+     */
+    changeUserEmail(email: UserEmail): Promise<void>;
+    changeUserPassword(currentPassword: UserPassword, newPassword: UserPassword): Promise<void>;
+    /**
+     * Change user email
+     *
+     * Users will receive {@link SfuEvent.CONTACT_UPDATED} with changed nickname
+     */
+    changeUserNickname(nickname: UserNickname): Promise<void>;
+    changeUserPhoneNumber(phoneNumber: UserPhoneNumber): Promise<void>;
+    changeUserHostKey(hostKey: UserHostKey): Promise<void>;
+    changeUserTimezone(timezone: UserTimezone): Promise<void>;
+    /**
+     * @deprecated
+     */
     getPublicChannels(): Promise<ChatMap>;
-    loadChat(chat: {
-        id: string;
-    }): Promise<Chat>;
-    loadMessages(params: {
-        targetEntityType: MessageTargetEntityType;
-        targetEntityId: MessageTargetEntityId;
-        timeFrame?: {
-            start: number;
-            end: number;
-            limit?: number;
-        };
-        boundaries?: {
-            dateMark: number;
-            lowerLimit: number;
-            upperLimit: number;
-        };
-    }): Promise<Message[]>;
+    /**
+     * @deprecated
+     */
     searchChatMessages(params: {
         chatId: string;
         searchString: string;
         searchId?: string;
         limit?: number;
     }): Promise<Message[]>;
-    getMessagesCount(options: {
-        targetEntityType: MessageTargetEntityType;
-        targetEntityId: MessageTargetEntityId;
-    }): Promise<ChatMessagesCount>;
-    getFirstAndLastMessage(options: {
-        targetEntityType: MessageTargetEntityType;
-        targetEntityId: MessageTargetEntityId;
-    }): Promise<FirstAndLastChatMessage>;
-    getUnreadMessagesCount(options: {
-        targetEntityType: MessageTargetEntityType;
-        targetEntityId: MessageTargetEntityId;
-    }): Promise<UnreadMessagesCountEvent>;
+    /**
+     * @deprecated
+     */
     searchMessageAttachments(params: {
         chatId?: string;
         attachmentsType?: MessageAttachmentMediaType;
@@ -178,6 +390,9 @@ export declare class SfuExtended {
         searchString?: string;
         sortOrder: SortOrder;
     }): Promise<MessageAttachmentsSearchResult>;
+    /**
+     * @deprecated
+     */
     loadMessagesWithMentions(params: {
         chatId?: string;
         userTag: string;
@@ -193,6 +408,24 @@ export declare class SfuExtended {
         };
         sortOrder: SortOrder;
     }): Promise<LoadMessagesWithMentionsResult>;
+    /**
+     * Get chats.
+     *
+     * To work with messages in the chat, you need to use {@link MessageTargetEntityType.CHAT}
+     */
+    getUserChats(): Promise<ChatMap>;
+    loadChat(chat: {
+        id: string;
+    }): Promise<Chat>;
+    /**
+     * Create chat
+     *
+     * @param chat.members - these members will receive {@link SfuEvent.NEW_CHAT} with {@link UserSpecificChatInfo}
+     * @param chat.type - @deprecated
+     * @param chat.channelSendPolicy - @deprecated
+     * @param chat.sendPermissionList - @deprecated
+     * @param chat.allowedToAddExternalUser - @deprecated
+     */
     createChat(chat: {
         id?: string;
         name?: string;
@@ -204,51 +437,55 @@ export declare class SfuExtended {
         sendPermissionList?: Array<string>;
         allowedToAddExternalUser?: boolean;
     }): Promise<UserSpecificChatInfo>;
+    /**
+     * Delete chat
+     *
+     * Chat members will receive {@link SfuEvent.CHAT_DELETED} with {@link UserSpecificChatInfo}
+     *
+     * If a direct meeting was started, it will end, and chat participants will receive {@link MeetingSyncEvent.MEETING_ENDED_SYNC} with {@link MeetingEndedSync}.
+     */
     deleteChat(chat: {
         id: string;
     }): Promise<void>;
+    /**
+     * Update chat
+     *
+     * Chat members will receive {@link SfuEvent.CHAT_UPDATED} with {@link UserSpecificChatInfo}
+     */
     renameChat(chat: {
         id: string;
         name: string;
     }): Promise<void>;
-    editMessage(msg: {
-        targetEntityType: MessageTargetEntityType;
-        targetEntityId: MessageTargetEntityId;
-        messageId: string;
-        body: string;
-        attachmentsToSend?: Array<MessageAttachment>;
-        attachmentIdsToDelete?: string[];
-    }): Promise<MessageStatus>;
-    deleteMessage(msg: {
-        targetEntityType: MessageTargetEntityType;
-        targetEntityId: MessageTargetEntityId;
-        messageId: string;
-    }): Promise<void>;
+    /**
+     *  Add a member to chat
+     *
+     * Chat members will receive {@link SfuEvent.CHAT_UPDATED} with {@link UserSpecificChatInfo}
+     *
+     * If a direct meeting was started, user will receive {@link SfuEvent.NEW_MEETING} with {@link NewMeeting}.
+     *
+     * @param chat.member - user will receive {@link SfuEvent.NEW_CHAT} with {@link UserSpecificChatInfo}.
+     */
     addMemberToChat(chat: {
         id: string;
         member: UserId;
     }): Promise<UserSpecificChatInfo>;
+    /**
+     *  Remove a member to chat
+     *
+     * Chat members will receive {@link SfuEvent.CHAT_UPDATED} with {@link UserSpecificChatInfo}
+     *
+     * If a direct meeting was started and user was , user will receive {@link MeetingSyncEvent.MEETING_ENDED_SYNC} with {@link MeetingEndedSync}.
+     * If the user was a participant in the meeting, users will receive {@link RoomEvent.EVICTED} with {@link EvictedFromRoom}.
+     *
+     * @param chat.member - user will receive {@link SfuEvent.CHAT_DELETED} with {@link UserSpecificChatInfo}.
+     */
     removeMemberFromChat(chat: {
         id: string;
         member: UserId;
     }): Promise<UserSpecificChatInfo>;
-    inviteContact(invite: {
-        to: UserId | UserEmail;
-    }): Promise<User>;
-    addContactToFavourites(contact: {
-        id: UserId;
-    }): Promise<User>;
-    removeContactFromFavourites(contact: {
-        id: UserId;
-    }): Promise<User>;
-    confirmContact(invite: {
-        id: string;
-        from: UserId;
-        to: UserId;
-    }): Promise<User>;
-    removeContact(contact: {
-        id: UserId;
-    }): Promise<User>;
+    /**
+     * @deprecated
+     */
     updateChannelSendPolicy(channel: {
         id: string;
         channelSendPolicy: ChannelSendPolicy;
@@ -257,14 +494,23 @@ export declare class SfuExtended {
         id: string;
         chatReceivePolicy: ChatReceivePolicy;
     }): Promise<UserSpecificChatInfo>;
+    /**
+     * @deprecated
+     */
     addChannelSendPermissionListMember(channel: {
         id: string;
         member: UserId;
     }): Promise<UserSpecificChatInfo>;
+    /**
+     * @deprecated
+     */
     removeChannelSendPermissionListMember(channel: {
         id: string;
         member: UserId;
     }): Promise<UserSpecificChatInfo>;
+    /**
+     * @deprecated
+     */
     updateChatConfiguration(chat: {
         id: string;
         type?: ChatType;
@@ -272,17 +518,58 @@ export declare class SfuExtended {
         sendPermissionList?: Array<string>;
         allowedToAddExternalUser?: boolean;
     }): Promise<UserSpecificChatInfo>;
+    /**
+     * Used to change {@link UserSpecificChatInfo.favourite} to true
+     */
     addChatToFavourites(chat: {
         id: string;
     }): Promise<UserSpecificChatInfo>;
+    /**
+     * Used to change {@link UserSpecificChatInfo.favourite} to false
+     */
     removeChatFromFavourites(chat: {
         id: string;
     }): Promise<UserSpecificChatInfo>;
+    /**
+     * Create room
+     *
+     * To create with PMI settings, PMI must be specified as the ID.
+     *
+     * To join, you need to use room.join.
+     *
+     * @return {@link RoomExtended} with {@link RoomExtended.conferenceType()} that equal {@link ConferenceType.GLOBAL}
+     */
     createRoom(options: {
         name?: string;
         pin?: string;
         id?: string;
     }): Promise<RoomExtended>;
+    /**
+     * Create channel meeting
+     *
+     * {@link Room.id()} will be equal channelId
+     *
+     * @return {@link RoomExtended} with {@link RoomExtended.conferenceType()} that equal {@link ConferenceType.CHANNEL}
+     */
+    createChannelMeeting(options: {
+        spaceId: string;
+        channelId: string;
+    }): Promise<RoomExtended>;
+    /**
+     * Create channel meeting
+     *
+     * {@link Room.id()} will be equal directChatId
+     *
+     * @return {@link RoomExtended} with {@link RoomExtended.conferenceType()} that equal {@link ConferenceType.DIRECT}
+     */
+    createDirectMeeting(options: {
+        directChatId: string;
+    }): Promise<RoomExtended>;
+    /**
+     * Creating a room based on a calendar event created using {@link addCalendarEvent}.
+     *
+     * To join, you need to use room.join()
+     */
     createRoomFromEvent(event: {
         id: string;
         title: string;
@@ -299,12 +586,23 @@ export declare class SfuExtended {
         useMuteAudioOnJoin: boolean;
         useLocalAutoRecord: boolean;
     }): Promise<RoomExtended>;
+    /**
+     * Get running rooms
+     */
     loadActiveRooms(): Promise<RoomInfo[]>;
+    /**
+     * Check and get an available room.
+     *
+     * To join, you need to use room.join()
+     */
     roomAvailable(options: {
         id: string;
         pin?: string;
         nickname?: string;
     }): Promise<RoomExtended>;
+    /**
+     * Checks for the existence of a running room.
+     */
     roomExists(options: {
         id: string;
         pin?: string;
@@ -312,46 +610,120 @@ export declare class SfuExtended {
     getRoom(options: {
         id: string;
     }): RoomExtended;
+    /**
+     * Get user spaces
+     *
+     * If channel meetings were started, user will receive {@link SfuEvent.USER_MEETINGS} with {@link MeetingsPreviewEvent}.
+     */
     getUserSpaces(): Promise<SfuSpace[]>;
-    createChannelMeeting(options: {
-        spaceId: string;
-        channelId: string;
-    }): Promise<RoomExtended>;
+    /**
+     * The space is created with the default category Category1, default channel Channel1 and default role "@everyone".
+     */
     createSpace(space: {
         name: string;
     }): Promise<SfuSpace>;
+    /**
+     * Update space overview
+     *
+     * Space members will receive {@link SpaceEvent.SPACE_OVERVIEW_UPDATED} with {@link SpaceOverviewUpdated}
+     */
     updateSpaceOverview(space: {
         id: string;
         name: string;
     }): Promise<void>;
+    /**
+     * Delete space
+     *
+     * Space members will receive {@link SpaceEvent.SPACE_DELETED} with {@link SpaceDeletedEvent}
+     *
+     * If channel meetings were started, users will receive {@link MeetingSyncEvent.MEETING_ENDED_SYNC} with {@link MeetingEndedSync}.
+     */
     deleteSpace(space: {
         id: string;
     }): Promise<string>;
+    /**
+     * Leave space
+     *
+     * Space members will receive {@link SpaceEvent.USER_LEFT_SPACE} with {@link UserLeftSpace}
+     *
+     * After receiving the event, it is necessary to remove the user from the list of members in the space and channels/threads.
+     *
+     * If channel meetings were started, user will receive {@link MeetingSyncEvent.MEETING_ENDED_SYNC} with {@link MeetingEndedSync}.
+     * If the user was a participant in the meeting, users will receive {@link RoomEvent.EVICTED} with {@link EvictedFromRoom}.
+     */
     leaveSpace(space: {
         id: string;
     }): Promise<void>;
+    /**
+     * Generate space invite
+     *
+     * If user has permission to create a space invite - generating invite code with 8 symbols.
+     * To create invite link - use 'ws:{serverUrl}:{port}/join-space/inviteCode'
+     */
     generateNewSpaceInvite(options: {
         spaceId: string;
         lifespan: number;
     }): Promise<SfuSpaceInvite>;
+    /**
+     * Removing the space invite
+     */
     revokeSpaceInvite(options: {
         spaceId: string;
         inviteCode: string;
     }): Promise<SfuSpaceInvite>;
+    /**
+     * Join space by invite code
+     *
+     * Space members will receive {@link SpaceEvent.USER_JOINED_TO_SPACE} with {@link UserJoinedToSpaceEvent}.
+     * On the client side, this user should be added to the list of participants in public channels and threads.
+     *
+     * If channel meetings were started, user will receive {@link SfuEvent.USER_MEETINGS} with {@link MeetingsPreviewEvent}.
+     */
     joinSpaceByInviteCode(inviteCode: string): Promise<SfuSpace>;
+    /**
+     * Create space category
+     *
+     * For space owner/user that has permission to manage categories
+     *
+     * Space members will receive {@link SpaceEvent.NEW_SPACE_CATEGORY} with {@link NewSpaceCategoryEvent}
+     */
     createSpaceCategory(category: {
         spaceId: string;
         name: string;
     }): Promise<SfuSpaceCategory>;
+    /**
+     * Delete space category
+     *
+     * For space owner/category creator/user that has permission to manage categories
+     *
+     * Space members will receive {@link SpaceEvent.SPACE_CATEGORY_DELETED} with {@link SpaceCategoryDeleted}
+     */
     deleteSpaceCategory(options: {
         spaceId: string;
         categoryId: string;
     }): Promise<SfuSpaceCategory>;
+    /**
+     * Delete space category
+     *
+     * For space owner/category creator/user that has permission to manage categories
+     *
+     * Space members will receive {@link SpaceEvent.SPACE_CATEGORY_UPDATED} with {@link SpaceCategoryUpdated}
+     */
     updateSpaceCategory(options: {
         spaceId: string;
         categoryId: string;
         name: string;
     }): Promise<void>;
+    /**
+     * Create space channel
+     *
+     * For space owner/user that has permission to manage channels
+     *
+     * Channel members will receive {@link SpaceEvent.NEW_SPACE_CHANNEL} with {@link NewSpaceChannelEvent}
+     *
+     * @param channel.roles - used to create a private channel. Array of role ids or empty array.
+     * @param channel.members - used to create a private channel. Array of member ids or empty array.
+     */
     createSpaceChannel(channel: {
         spaceId: string;
         categoryId?: string;
@@ -360,6 +732,22 @@ export declare class SfuExtended {
         roles?: Array<string>;
         members?: Array<string>;
     }): Promise<SfuSpaceChannel>;
+    /**
+     * Update space channel
+     *
+     * For space owner/user that has permission to manage channels
+     *
+     * Channel members will receive {@link SpaceEvent.SPACE_CHANNEL_UPDATED} with {@link SpaceChannelUpdated}
+     * In the private channel added members will receive {@link SpaceEvent.NEW_SPACE_CHANNEL} with {@link NewSpaceChannelEvent}.
+     * If the channel meeting was started, added members will receive {@link SfuEvent.NEW_MEETING} with {@link NewMeeting}.
+     *
+     * In the private channel deleted members will receive {@link SpaceEvent.SPACE_CHANNEL_DELETED} with {@link SpaceChannelDeleted}
+     * If the channel meeting was started, deleted members will receive {@link MeetingSyncEvent.MEETING_ENDED_SYNC} with {@link MeetingEndedSync}.
+     * If the deleted user was a participant in the meeting, users will receive {@link RoomEvent.EVICTED} with {@link EvictedFromRoom}.
+     *
+     * @param channel.roles - used to create a private channel. Array of role ids or empty array.
+     * @param channel.members - used to create a private channel. Array of member ids or empty array.
+     */
     updateSpaceChannel(channel: {
         spaceId: string;
         channelId: string;
@@ -368,32 +756,74 @@ export declare class SfuExtended {
         roles?: Array<string>;
         members?: Array<string>;
     }): Promise<SpaceChannelUpdated>;
+    /**
+     * Move space channel
+     *
+     * Channel members will receive {@link SpaceEvent.SPACE_CHANNEL_MOVED} with {@link SpaceChannelMoved}
+     *
+     * @param channel.categoryId - Specify the identifier of the category to which you want to move the channel, or an empty string to leave the channel uncategorized.
+     */
     moveSpaceChannel(channel: {
         spaceId: string;
         categoryId: string;
         channelId: string;
     }): Promise<SpaceChannelMoved>;
+    /**
+     * Delete space channel
+     *
+     * Channel members will receive {@link SpaceEvent.SPACE_CHANNEL_DELETED} with {@link SpaceChannelDeleted}
+     *
+     * If the channel meeting was started, members will receive {@link MeetingSyncEvent.MEETING_ENDED_SYNC} with {@link MeetingEndedSync}.
+     */
     deleteSpaceChannel(options: {
         spaceId: string;
         channelId: string;
     }): Promise<void>;
+    /**
+     * Create space thread
+     *
+     * Thread members will receive {@link SpaceEvent.NEW_SPACE_THREAD} with {@link NewSpaceThreadEvent}
+     */
     createSpaceThread(thread: {
         spaceId: string;
         channelId: string;
         name: string;
         isPrivate: boolean;
     }): Promise<SfuSpaceThread>;
+    /**
+     * Update space thread
+     *
+     * For space owner/thread creator
+     *
+     * Thread members will receive {@link SpaceEvent.SPACE_THREAD_UPDATED} with {@link SpaceThreadUpdated}
+     */
     updateSpaceThread(options: {
         spaceId: string;
         channelId: string;
         threadId: string;
         name: string;
     }): Promise<void>;
+    /**
+     * Delete space thread
+     *
+     * For space owner/thread creator
+     *
+     * Thread members will receive {@link SpaceEvent.SPACE_THREAD_DELETED} with {@link SpaceThreadDeleted}
+     */
     deleteSpaceThread(options: {
         spaceId: string;
         channelId: string;
         threadId: string;
     }): Promise<void>;
+    /**
+     * Add space role
+     *
+     * For space owner/user that has permission to manage roles
+     *
+     * Space members will receive {@link SpaceEvent.NEW_SPACE_ROLE} with {@link NewSpaceRoleAdded}
+     *
+     * On the client side, a new role must be added to the participants listed in the {@link NewSpaceRoleAdded.members}
+     */
     addSpaceRole(role: {
         spaceId: string;
         name: string;
@@ -401,6 +831,22 @@ export declare class SfuExtended {
         permissions: Array<string>;
         members: Array<string>;
     }): Promise<SfuSpaceRole>;
+    /**
+     * Update space role
+     *
+     * For space owner/user that has permission to manage roles
+     *
+     * Space members will receive {@link SpaceEvent.SPACE_ROLE_UPDATED} with {@link SpaceRoleUpdated}
+     *
+     * On the client side, a new role must be added to the participants listed in the {@link SpaceRoleUpdated.membersForAddRole}
+     * and must be removed from participants listed in the {@link SpaceRoleUpdated.membersForDeleteRole}
+     *
+     * Participants from whom this role will be removed will receive {@link SpaceEvent.SPACE_CHANNEL_DELETED} with {@link SpaceChannelDeleted} for each channel they were part of because of this role.
+     *
+     * Participants who are assigned this role will receive {@link SpaceEvent.NEW_SPACE_CHANNEL} with {@link NewSpaceChannelEvent} for each channel that has this role in its access rights.
+     *
+     * Participants who had the role before the update and still have it afterward will receive {@link SpaceEvent.SPACE_CHANNEL_UPDATED} with {@link SpaceChannelUpdated} for each channel that has this role in its access rights.
+     */
     updateSpaceRole(role: {
         spaceId: string;
         roleId: string;
@@ -409,22 +855,50 @@ export declare class SfuExtended {
         permissions: Array<string>;
         members: Array<string>;
     }): Promise<SpaceRoleUpdated>;
+    /**
+     * Delete space role
+     *
+     * For space owner/user that has permission to manage roles
+     *
+     * Space members will receive {@link SpaceEvent.SPACE_ROLE_DELETED} with {@link SpaceRoleDeleted}
+     *
+     * On the client side, should remove this role from channel's access rights and update channel members list
+     */
     deleteSpaceRole(options: {
         spaceId: string;
         roleId: string;
     }): Promise<SpaceRoleDeleted>;
+    /**
+     * Add space role to member
+     *
+     * For space owner/user that has permission to manage roles
+     *
+     * Space members will receive {@link SpaceEvent.ADDED_ROLE_TO_MEMBER} with {@link AddedRoleToMember}
+     *
+     * Member who are assigned this role will receive {@link SpaceEvent.NEW_SPACE_CHANNEL} with {@link NewSpaceChannelEvent} for each channel that has this role in its access rights.
+     * Other members of these channels will receive {@link SpaceEvent.SPACE_CHANNEL_UPDATED} with {@link SpaceChannelUpdated}.
+     */
     addRoleToMember(options: {
         spaceId: string;
         roleId: string;
         memberId: string;
     }): Promise<AddedRoleToMember>;
+    /**
+     * Remove space role from member
+     *
+     * For space owner/user that has permission to manage roles
+     *
+     * Space members will receive {@link SpaceEvent.REMOVED_ROLE_FROM_MEMBER} with {@link RemovedRoleFromMember}
+     *
+     * Participant from whom this role will be removed will receive {@link SpaceEvent.SPACE_CHANNEL_DELETED} with {@link SpaceChannelDeleted} for each channel they were part of because of this role.
+     * Other members of these channels will receive {@link SpaceEvent.SPACE_CHANNEL_UPDATED} with {@link SpaceChannelUpdated}.
+     */
     removeRoleFromMember(options: {
         spaceId: string;
         roleId: string;
         memberId: string;
     }): Promise<RemovedRoleFromMember>;
     getRolePermissions(): Promise<SfuSpaceRolePermissionSection[]>;
-    disconnect(): Promise<void>;
     user(): {
         username: string;
         email: string;