Class SfuExtended

Index

Constructors

Properties

#_server #_state #_url #_user #attachmentsTransferManager #binaryChunkSize #connection #logger #loggerPrefix #notifier #resetPasswordId #rooms #signUpId #uploadingAttachmentState

Methods

#checkAuthenticated #createConnection #emmitAction #emmitBinaryAction #getConnectionConfigForAnonymousUser #getConnectionConfigForExamples acceptFriendInvite addCalendarEvent addChannelSendPermissionListMember addChatToFavourites addFriend addMemberToChat addMembersToThread addReactionOnMessage addRoleToMember addSpaceRole addUserEncryptionInfo changeUserEmail changeUserHostKey changeUserNickname changeUserPassword changeUserPhoneNumber changeUserTimezone closePcAndFireEvent connect createChannelMeeting createChat createDirectMeeting createRoom createRoomFromEvent createSpace createSpaceCategory createSpaceChannel createSpaceThread deleteChat deleteMessage deleteSpace deleteSpaceCategory deleteSpaceChannel deleteSpaceRole deleteSpaceThread disconnect downloadAttachment editMessage ensureUsernameAvailable generateNewSpaceInvite getAttachmentsSize getContacts getExamplesFreeUser getFirstAndLastMessage getMessageAttachment getMessagesCount getPublicChannels getRolePermissions getRoom getSendingAttachmentsHandler getSystemConfig getUnreadMessagesCount getUserCalendar getUserChats getUserEncryptionInfo getUserInfo getUserPmiSettings getUserSpaces joinSpaceByInviteCode leaveSpace listAttachments loadActiveRooms loadChat loadMeetingsHistory loadMessages loadMessagesWithMentions logout markMessageRead markMessageUnread moveSpaceChannel muteChannel muteChat muteSpace muteThread off on rejectFriendInvite removeCalendarEvent removeChannelSendPermissionListMember removeChatFromFavourites removeFriend removeMeetingFromHistory removeMeetingRecord removeMemberFromChat removeMemberFromThread removeReactionOnMessage removeRoleFromMember removeUser renameChat resetPassword revokeFriendInvite revokeSpaceInvite roomAvailable roomExists searchChatMessages searchMessageAttachments sendMessage server signUp state unmuteChannel unmuteChat unmuteSpace unmuteThread updateActivityStatus updateCalendarEvent updateChannelNotificationSettings updateChannelSendPolicy updateChatConfiguration updateChatHiding updateChatIcon updateChatIconRequest updateChatNotificationSettings updateChatReceivePolicy updateContactVolume updatePresenceStatus updateSpaceCategory updateSpaceChannel updateSpaceIcon updateSpaceIconRequest updateSpaceNickname updateSpaceNotificationSettings updateSpaceOverview updateSpaceRole updateSpaceThread updateThreadNotificationSettings updateUserIcon updateUserIconRequest updateUserPmiSettings user fromUTF8ArrayToStr generateAttachmentId strToUTF8Array

Constructors

constructor

new SfuExtended(logLevel?, prefix?, log?): SfuExtended
Parameters
- Optional logLevel: Verbosity
- Optional prefix: PrefixFunction
- Optional log: any
Returns SfuExtended
- Defined in sfu-extended.ts:219

Properties

`Private` #_server

#_server: string

`Private` #_state

#_state: State = State.NEW

`Private` #_url

#_url: string

`Private` #_user

#_user: {
    authToken: string;
    email: string;
    nickname: string;
    pmi: string;
    username: string;
    webRTCMetricsServerDescription?: RTCMetricsServerDescription;
}

Type declaration

authToken: string
email: string
nickname: string
pmi: string
username: string
Optional webRTCMetricsServerDescription?: RTCMetricsServerDescription

`Private` #attachmentsTransferManager

#attachmentsTransferManager: AttachmentsTransferManager = ...

`Private` #binaryChunkSize

#binaryChunkSize: number

`Private` #connection

#connection: Connection

`Private` #logger

#logger: default = ...

`Private` #loggerPrefix

#loggerPrefix: PrefixFunction

`Private` #notifier

#notifier: Notifier<EventUnion, NotifyUnion> = ...

`Private` #resetPasswordId

#resetPasswordId: string = ''

`Private` #rooms

#rooms: {
[key: string]: RoomExtended;
} = {}

Type declaration

[key: string]: RoomExtended

`Private` #signUpId

#signUpId: string = ''

`Private` #uploadingAttachmentState

#uploadingAttachmentState: MessageWithUploadingAttachmentState = {}

Methods

`Private` #checkAuthenticated

#checkAuthenticated(): void
Returns void
- Defined in sfu-extended.ts:244

`Private` #createConnection

#createConnection(): void
Returns void
- Defined in sfu-extended.ts:336

`Private` #emmitAction

#emmitAction(action, data, resolve, reject): void
Parameters
- action: InternalApi
- data: object
- resolve: Function
- reject: Function
Returns void
- Defined in sfu-extended.ts:231

`Private` #emmitBinaryAction

#emmitBinaryAction(data): void
Parameters
- data: any
Returns void
- Defined in sfu-extended.ts:240

`Private` #getConnectionConfigForAnonymousUser

#getConnectionConfigForAnonymousUser(url, timeout?): {
    appName: InternalApi;
    custom: {
        nickname: string;
        password: string;
        username: string;
    };
    timeout: number;
    url: string;
}
Parameters
- url: string
- Optional timeout: number
Returns {
    appName: InternalApi;
    custom: {
        nickname: string;
        password: string;
        username: string;
    };
    timeout: number;
    url: string;
}
- appName: InternalApi
- custom: {
      nickname: string;
      password: string;
      username: string;
  }
  - nickname: string
  - password: string
  - username: string
- timeout: number
- url: string
- Defined in sfu-extended.ts:1328

`Private` #getConnectionConfigForExamples

#getConnectionConfigForExamples(url, timeout?): {
    appName: InternalApi;
    custom: {
        nickname: string;
        password: string;
        username: string;
    };
    timeout: number;
    url: string;
}
Parameters
- url: string
- Optional timeout: number
Returns {
    appName: InternalApi;
    custom: {
        nickname: string;
        password: string;
        username: string;
    };
    timeout: number;
    url: string;
}
- appName: InternalApi
- custom: {
      nickname: string;
      password: string;
      username: string;
  }
  - nickname: string
  - password: string
  - username: string
- timeout: number
- url: string
- Defined in sfu-extended.ts:3963

acceptFriendInvite

acceptFriendInvite(invite): Promise<Contact>
Accept friend invite

Users will receive SfuEvent.OUTGOING_FRIEND_INVITE_DELETED and SfuEvent.INCOMING_FRIEND_INVITE_DELETED with FriendInviteDeleted for invites. Users will receive SfuEvent.CONTACT_UPDATED with ContactUpdated if they have mutual space channels or direct chats. Will receive SfuEvent.NEW_CONTACT with NewContact if haven't.
Parameters
- invite: {
  inviteId: string;
  }
  - inviteId: string
Returns Promise<Contact>
- Defined in sfu-extended.ts:1930

addCalendarEvent

addCalendarEvent(event): Promise<CalendarEvent>
Add calendar event
Parameters
- event: {
      accessCode?: string;
      allowJoinAtAnyTime: boolean;
      description: string;
      end: number;
      ownerVideo: boolean;
      participantVideo: boolean;
      recurring: boolean;
      start: number;
      title: string;
      useLocalAutoRecord: boolean;
      useMuteAudioOnJoin: boolean;
      usePMI: boolean;
      waitingRoom: boolean;
  }
  - Optional accessCode?: string
  - allowJoinAtAnyTime: boolean
  - description: string
  - end: number
  - ownerVideo: boolean
  - participantVideo: boolean
  - recurring: boolean
  - start: number
  - title: string
  - useLocalAutoRecord: boolean
  - useMuteAudioOnJoin: boolean
  - usePMI: boolean
    if true then user PMI settings will be updated and user will receive SfuEvent.UPDATE_USER_PMI_SETTINGS with UserPmiSettings
  - waitingRoom: boolean
Returns Promise<CalendarEvent>
- Defined in sfu-extended.ts:1999

addChannelSendPermissionListMember

addChannelSendPermissionListMember(channel): Promise<UserSpecificChatInfo>
Parameters
- channel: {
  id: string;
  member: string;
  }
  - id: string
  - member: string
Returns Promise<UserSpecificChatInfo>
Deprecated
- Defined in sfu-extended.ts:2616

addChatToFavourites

addChatToFavourites(chat): Promise<UserSpecificChatInfo>
Used to change UserSpecificChatInfo.favourite to true
Parameters
- chat: {
  id: string;
  }
  - id: string
Returns Promise<UserSpecificChatInfo>
- Defined in sfu-extended.ts:2667

addFriend

addFriend(user): Promise<void>
Add a friend

Sends a friend invite. Users will receive SfuEvent.NEW_OUTGOING_FRIEND_INVITE and SfuEvent.NEW_INCOMING_FRIEND_INVITE with NewFriendInvite.

If an invite was sent to this user previously, it will be replaced with a new one. Users will receive SfuEvent.OUTGOING_FRIEND_INVITE_DELETED and SfuEvent.INCOMING_FRIEND_INVITE_DELETED with FriendInviteDeleted for previously invite. Users will receive SfuEvent.NEW_OUTGOING_FRIEND_INVITE and SfuEvent.NEW_INCOMING_FRIEND_INVITE with NewFriendInvite for new friend invite.

If the user that you are trying to add as a friend has already sent you an invite, sending a counter-invite will automatically add you as friends. Users will receive SfuEvent.OUTGOING_FRIEND_INVITE_DELETED and SfuEvent.INCOMING_FRIEND_INVITE_DELETED with FriendInviteDeleted for invites. Users will receive SfuEvent.CONTACT_UPDATED with ContactUpdated if they have mutual space channels or direct chats. Will receive SfuEvent.NEW_CONTACT with NewContact if haven't.
Parameters
- user: {
  userId: string;
  }
  - userId: string
Returns Promise<void>
- Defined in sfu-extended.ts:1876

addMemberToChat

addMemberToChat(chat): Promise<UserSpecificChatInfo>
Add a member to chat

Chat members will receive SfuEvent.CHAT_UPDATED with UserSpecificChatInfo

If a direct meeting was started, user will receive SfuEvent.NEW_MEETING with NewMeeting.
Parameters
- chat: {
      encryptedChatPassword?: string;
      id: string;
      member: string;
  }
  - Optional encryptedChatPassword?: string
    required for adding to a secure encrypted chat. chat password encrypted with the member's public key, which must be decrypted using the user's private key.
  - id: string
  - member: string
    user will receive SfuEvent.NEW_CHAT with UserSpecificChatInfo.
Returns Promise<UserSpecificChatInfo>
- Defined in sfu-extended.ts:2545

addMembersToThread

addMembersToThread(options): Promise<AddedMembersToThread>
Add members to thread

Thread members will receive SpaceEvent.ADDED_MEMBERS_TO_THREAD with AddedMembersToThread

New members will receive NEW_SPACE_THREAD with NewSpaceThreadEvent
Parameters
- options: {
      channelId: string;
      members: string[];
      spaceId: string;
      threadId: string;
  }
  - channelId: string
  - members: string[]
  - spaceId: string
  - threadId: string
Returns Promise<AddedMembersToThread>
- Defined in sfu-extended.ts:3371

addReactionOnMessage

addReactionOnMessage(msg): Promise<AddedRemovedReactionOnMessage>
Add reaction on message in a Direct chat | Channel | Thread

Members will receive SfuEvent.REACTION_ON_MESSAGE_ADDED with AddedRemovedReactionOnMessage
Parameters
- msg: {
      messageId: string;
      reaction: string;
      targetEntityId: MessageTargetEntityId;
      targetEntityType: MessageTargetEntityType;
  }
  - messageId: string
  - reaction: string
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
Returns Promise<AddedRemovedReactionOnMessage>
- Defined in sfu-extended.ts:1467

addRoleToMember

addRoleToMember(options): Promise<AddedRoleToMember>
Add space role to member

For space owner/user that has permission to manage roles

Space members will receive SpaceEvent.ADDED_ROLE_TO_MEMBER with AddedRoleToMember

Member who are assigned this role will receive SpaceEvent.NEW_SPACE_CHANNEL with NewSpaceChannelEvent for each channel that has this role in its access rights. Other members of these channels will receive SpaceEvent.SPACE_CHANNEL_UPDATED with SpaceChannelUpdated.
Parameters
- options: {
      memberId: string;
      roleId: string;
      spaceId: string;
  }
  - memberId: string
  - roleId: string
  - spaceId: string
Returns Promise<AddedRoleToMember>
- Defined in sfu-extended.ts:3615

addSpaceRole

addSpaceRole(role): Promise<SfuSpaceRole>
Add space role

For space owner/user that has permission to manage roles

Space members will receive SpaceEvent.NEW_SPACE_ROLE with NewSpaceRoleAdded

On the client side, a new role must be added to the participants listed in the NewSpaceRoleAdded.members
Parameters
- role: {
      color: string;
      members: string[];
      name: string;
      permissions: string[];
      spaceId: string;
  }
  - color: string
  - members: string[]
  - name: string
  - permissions: string[]
  - spaceId: string
Returns Promise<SfuSpaceRole>
- Defined in sfu-extended.ts:3524

addUserEncryptionInfo

addUserEncryptionInfo(info): Promise<UserEncryptionInfo>
After adding:

User's contacts will see Contact.encryptionEnabled and Contact.publicKey. The remaining information is not used on the server and is only stored; it can be requested using getUserEncryptionInfo.

verificationHash, salt, and iv are optional; the client chooses the private key encryption method.

salt - Cryptographic Salt

iv - Initialization Vector for Encryption
Parameters
- info: {
      iv?: string;
      privateKey: string;
      publicKey: string;
      salt?: string;
      verificationHash?: string;
  }
  - Optional iv?: string
  - privateKey: string
  - publicKey: string
  - Optional salt?: string
  - Optional verificationHash?: string
Returns Promise<UserEncryptionInfo>
- Defined in sfu-extended.ts:2239

changeUserEmail

changeUserEmail(email): Promise<void>
Change user email
Parameters
- email: string
Returns Promise<void>
- Defined in sfu-extended.ts:2116

changeUserHostKey

changeUserHostKey(hostKey): Promise<void>
Parameters
- hostKey: string
Returns Promise<void>
- Defined in sfu-extended.ts:2164

changeUserNickname

changeUserNickname(nickname): Promise<void>
Change user email

Users will receive SfuEvent.CONTACT_UPDATED with changed nickname
Parameters
- nickname: string
Returns Promise<void>
- Defined in sfu-extended.ts:2144

changeUserPassword

changeUserPassword(currentPassword, newPassword): Promise<void>
Parameters
- currentPassword: string
- newPassword: string
Returns Promise<void>
- Defined in sfu-extended.ts:2126

changeUserPhoneNumber

changeUserPhoneNumber(phoneNumber): Promise<void>
Parameters
- phoneNumber: string
Returns Promise<void>
- Defined in sfu-extended.ts:2154

changeUserTimezone

changeUserTimezone(timezone): Promise<void>
Parameters
- timezone: string
Returns Promise<void>
- Defined in sfu-extended.ts:2174

`Private` closePcAndFireEvent

closePcAndFireEvent(room): void
Parameters
- room: RoomExtended
Returns void
- Defined in sfu-extended.ts:4073

connect

connect(options): Promise<{
    authToken: string;
    email: string;
    nickname: string;
    pmi: string;
    username: string;
}>
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 state will change to State.AUTHENTICATED. After that, the sfu-sdk will emit the event SfuEvent.CONNECTED.
Parameters
- options: {
      authToken?: string;
      binaryChunkSize?: number;
      details?: ConnectionDetails;
      device?: string;
      failedProbesThreshold?: number;
      nickname?: string;
      password?: string;
      pingInterval?: number;
      timeout?: number;
      url: string;
      username?: string;
  }
  - Optional authToken?: string
    The authentication token for direct login (optional if username and password are provided).
    
    After successfully connection user contacts will receive an SfuEvent.USER_PRESENCE_STATUS_UPDATED with UserPresenceStatusUpdated
  - Optional binaryChunkSize?: number
  - Optional details?: ConnectionDetails
  - Optional device?: string
  - Optional failedProbesThreshold?: number
  - Optional nickname?: string
  - Optional password?: string
    The user's password (optional if authToken is provided).
  - Optional pingInterval?: number
  - Optional timeout?: number
  - url: string
  - Optional username?: string
    The user's username (optional if authToken is provided).
Returns Promise<{
    authToken: string;
    email: string;
    nickname: string;
    pmi: string;
    username: string;
}>
- Defined in sfu-extended.ts:264

createChannelMeeting

createChannelMeeting(options): Promise<RoomExtended>
Create channel meeting

Room.id() will be equal channelId
Parameters
- options: {
  channelId: string;
  spaceId: string;
  }
  - channelId: string
  - spaceId: string
Returns Promise<RoomExtended>
RoomExtended with () that equal ConferenceType.CHANNEL
- Defined in sfu-extended.ts:2739

createChat

createChat(chat): Promise<UserSpecificChatInfo>
Create chat
Parameters
- chat: {
      allowedToAddExternalUser?: boolean;
      channel?: boolean;
      channelSendPolicy?: ChannelSendPolicy;
      encryptedAttachmentsSecretKey?: string;
      encryptedChatPasswords?: UserChatEncryptedPassword[];
      encryptedPrivateKey?: string;
      favourite?: boolean;
      id?: string;
      isEncryptionEnabled?: boolean;
      members?: string[];
      name?: string;
      publicKey?: string;
      sendPermissionList?: string[];
      type?: ChatType;
  }
  - Optional allowedToAddExternalUser?: boolean
  - Optional channel?: boolean
  - Optional channelSendPolicy?: ChannelSendPolicy
  - Optional encryptedAttachmentsSecretKey?: string
    encrypted key for encrypting attachments.
  - Optional encryptedChatPasswords?: UserChatEncryptedPassword[]
    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.
  - Optional encryptedPrivateKey?: string
    the private key of the chat, encrypted with a chat password, used to decrypt messages
  - Optional favourite?: boolean
  - Optional id?: string
  - Optional isEncryptionEnabled?: boolean
    must be true for a Secure Chat
  - Optional members?: string[]
    these members will receive SfuEvent.NEW_CHAT with UserSpecificChatInfo
  - Optional name?: string
  - Optional publicKey?: string
    the public key of the chat used to encrypt messages
  - Optional sendPermissionList?: string[]
  - Optional type?: ChatType
Returns Promise<UserSpecificChatInfo>
Deprecated
Deprecated
Deprecated
Deprecated
Creating a Secure Chat with Encryption:
- Defined in sfu-extended.ts:2399

createDirectMeeting

createDirectMeeting(options): Promise<RoomExtended>
Create channel meeting

Room.id() will be equal directChatId
Parameters
- options: {
  directChatId: string;
  }
  - directChatId: string
Returns Promise<RoomExtended>
RoomExtended with () that equal ConferenceType.DIRECT
- Defined in sfu-extended.ts:2760

createRoom

createRoom(options): Promise<RoomExtended>
Create room

To create with PMI settings, PMI must be specified as the ID.

To join, you need to use room.join.
Parameters
- options: {
      id?: string;
      name?: string;
      pin?: string;
  }
  - Optional id?: string
  - Optional name?: string
  - Optional pin?: string
Returns Promise<RoomExtended>
RoomExtended with () that equal ConferenceType.GLOBAL
- Defined in sfu-extended.ts:2716

createRoomFromEvent

createRoomFromEvent(event): Promise<RoomExtended>
Creating a room based on a calendar event created using addCalendarEvent.

To join, you need to use room.join()
Parameters
- event: {
      accessCode?: string;
      allowJoinAtAnyTime: boolean;
      description: string;
      end: number;
      id: string;
      ownerVideo: boolean;
      participantVideo: boolean;
      recurring: boolean;
      start: number;
      title: string;
      useLocalAutoRecord: boolean;
      useMuteAudioOnJoin: boolean;
      usePMI: boolean;
      waitingRoom: boolean;
  }
  - Optional accessCode?: string
  - allowJoinAtAnyTime: boolean
  - description: string
  - end: number
  - id: string
  - ownerVideo: boolean
  - participantVideo: boolean
  - recurring: boolean
  - start: number
  - title: string
  - useLocalAutoRecord: boolean
  - useMuteAudioOnJoin: boolean
  - usePMI: boolean
  - waitingRoom: boolean
Returns Promise<RoomExtended>
- Defined in sfu-extended.ts:2777

createSpace

createSpace(space): Promise<SfuSpace>
The space is created with the default category Category1, default channel Channel1 and default role "@everyone".
Parameters
- space: {
  name: string;
  }
  - name: string
Returns Promise<SfuSpace>
- Defined in sfu-extended.ts:2875

createSpaceCategory

createSpaceCategory(category): Promise<SfuSpaceCategory>
Create space category

For space owner/user that has permission to manage categories

Space members will receive SpaceEvent.NEW_SPACE_CATEGORY with NewSpaceCategoryEvent
Parameters
- category: {
  name: string;
  spaceId: string;
  }
  - name: string
  - spaceId: string
Returns Promise<SfuSpaceCategory>
- Defined in sfu-extended.ts:3073

createSpaceChannel

createSpaceChannel(channel): Promise<SfuSpaceChannel>
Create space channel

For space owner/user that has permission to manage channels

Channel members will receive SpaceEvent.NEW_SPACE_CHANNEL with NewSpaceChannelEvent
Parameters
- channel: {
      categoryId?: string;
      isPrivate: boolean;
      members?: string[];
      name: string;
      roles?: string[];
      spaceId: string;
  }
  - Optional categoryId?: string
  - isPrivate: boolean
  - Optional members?: string[]
    used to create a private channel. Array of member ids or empty array.
  - name: string
  - Optional roles?: string[]
    used to create a private channel. Array of role ids or empty array.
  - spaceId: string
Returns Promise<SfuSpaceChannel>
- Defined in sfu-extended.ts:3141

createSpaceThread

createSpaceThread(thread): Promise<SfuSpaceThread>
Create space thread

Thread members will receive SpaceEvent.NEW_SPACE_THREAD with NewSpaceThreadEvent
Parameters
- thread: {
      channelId: string;
      isPrivate: boolean;
      name: string;
      spaceId: string;
  }
  - channelId: string
  - isPrivate: boolean
  - name: string
  - spaceId: string
Returns Promise<SfuSpaceThread>
- Defined in sfu-extended.ts:3320

deleteChat

deleteChat(chat): Promise<void>
Delete chat

Chat members will receive SfuEvent.CHAT_DELETED with UserSpecificChatInfo

If a direct meeting was started, it will end, and chat participants will receive MeetingSyncEvent.MEETING_ENDED_SYNC with MeetingEndedSync.
Parameters
- chat: {
  id: string;
  }
  - id: string
Returns Promise<void>
- Defined in sfu-extended.ts:2444

deleteMessage

deleteMessage(msg): Promise<void>
Delete a message in a Direct chat | Channel | Thread

The message body will be changed to an empty string. The Message.status will be changed to MessageState.DELETED

Attachments will be removed.

Members will receive SfuEvent.CHAT_MESSAGE_DELETED with MessageDeleted
Parameters
- msg: {
      messageId: string;
      targetEntityId: MessageTargetEntityId;
      targetEntityType: MessageTargetEntityType;
  }
  - messageId: string
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
Returns Promise<void>
- Defined in sfu-extended.ts:1446

deleteSpace

deleteSpace(space): Promise<string>
Delete space

Space members will receive SpaceEvent.SPACE_DELETED with SpaceDeletedEvent

If channel meetings were started, users will receive MeetingSyncEvent.MEETING_ENDED_SYNC with MeetingEndedSync.
Parameters
- space: {
  id: string;
  }
  - id: string
Returns Promise<string>
- Defined in sfu-extended.ts:2913

deleteSpaceCategory

deleteSpaceCategory(options): Promise<SfuSpaceCategory>
Delete space category

For space owner/category creator/user that has permission to manage categories

Space members will receive SpaceEvent.SPACE_CATEGORY_DELETED with SpaceCategoryDeleted
Parameters
- options: {
  categoryId: string;
  spaceId: string;
  }
  - categoryId: string
  - spaceId: string
Returns Promise<SfuSpaceCategory>
- Defined in sfu-extended.ts:3094

deleteSpaceChannel

deleteSpaceChannel(options): Promise<void>
Delete space channel

Channel members will receive SpaceEvent.SPACE_CHANNEL_DELETED with SpaceChannelDeleted

If the channel meeting was started, members will receive MeetingSyncEvent.MEETING_ENDED_SYNC with MeetingEndedSync.
Parameters
- options: {
  channelId: string;
  spaceId: string;
  }
  - channelId: string
  - spaceId: string
Returns Promise<void>
- Defined in sfu-extended.ts:3231

deleteSpaceRole

deleteSpaceRole(options): Promise<SpaceRoleDeleted>
Delete space role

For space owner/user that has permission to manage roles

Space members will receive SpaceEvent.SPACE_ROLE_DELETED with SpaceRoleDeleted

On the client side, should remove this role from channel's access rights and update channel members list
Parameters
- options: {
  roleId: string;
  spaceId: string;
  }
  - roleId: string
  - spaceId: string
Returns Promise<SpaceRoleDeleted>
- Defined in sfu-extended.ts:3591

deleteSpaceThread

deleteSpaceThread(options): Promise<void>
Delete space thread

For space owner/thread creator

Thread members will receive SpaceEvent.SPACE_THREAD_DELETED with SpaceThreadDeleted
Parameters
- options: {
      channelId: string;
      spaceId: string;
      threadId: string;
  }
  - channelId: string
  - spaceId: string
  - threadId: string
Returns Promise<void>
- Defined in sfu-extended.ts:3423

disconnect

disconnect(): Promise<void>
Method to disconnect from the server

When disconnecting, user leaves all active rooms

state changed to DISCONNECTED

After disconnection user contacts will receive an SfuEvent.USER_PRESENCE_STATUS_UPDATED with UserPresenceStatusUpdated

Returns Promise<void>
- Defined in sfu-extended.ts:1014

`Private` downloadAttachment

downloadAttachment(attachment): Promise<Attachment>
Parameters
- attachment: AttachmentRequest
Returns Promise<Attachment>
- Defined in sfu-extended.ts:1823

editMessage

editMessage(msg): Promise<MessageStatus>
Edit a message in a Direct chat | Channel | Thread

Members will receive SfuEvent.CHAT_MESSAGE_EDITED with MessageEdited
Parameters
- msg: {
      attachmentIdsToDelete?: string[];
      attachmentsToSend?: MessageAttachment[];
      body: string;
      messageId: string;
      targetEntityId: MessageTargetEntityId;
      targetEntityType: MessageTargetEntityType;
  }
  - Optional attachmentIdsToDelete?: string[]
    to send a private message
  - Optional attachmentsToSend?: MessageAttachment[]
    to add attachments to sent message
  - body: string
  - messageId: string
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
Returns Promise<MessageStatus>
- Defined in sfu-extended.ts:1414

ensureUsernameAvailable

ensureUsernameAvailable(options): Promise<void>
Ensure username available

If the username is not taken, the promise will resolve with void.

If the username is taken, the promise will reject with UserManagementError.USERNAME_ALREADY_IN_USE.
Parameters
- options: {
      timeout?: number;
      url: string;
      username: string;
  }
  - Optional timeout?: number
  - url: string
  - username: string
Returns Promise<void>
- Defined in sfu-extended.ts:1110

generateNewSpaceInvite

generateNewSpaceInvite(options): Promise<SfuSpaceInvite>
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'
Parameters
- options: {
  lifespan: number;
  spaceId: string;
  }
  - lifespan: number
  - spaceId: string
Returns Promise<SfuSpaceInvite>
- Defined in sfu-extended.ts:3017

getAttachmentsSize

getAttachmentsSize(type?): Promise<AttachmentSizeInfo>
Get total size of attachments
Parameters
- Optional type: AttachmentType
  AttachmentType
Returns Promise<AttachmentSizeInfo>
- Defined in sfu-extended.ts:1612

getContacts

getContacts(): Promise<UserContacts>
Get user contacts.

Returns users who are friends or with whom there are mutual space channels or direct chats, incoming and outgoing friend invites, banned users.

Returns Promise<UserContacts>
- Defined in sfu-extended.ts:1853

getExamplesFreeUser

getExamplesFreeUser(options): Promise<ExamplesUser>
Parameters
- options: {
  timeout?: number;
  url: string;
  }
  - Optional timeout?: number
  - url: string
Returns Promise<ExamplesUser>
- Defined in sfu-extended.ts:3976

getFirstAndLastMessage

getFirstAndLastMessage(options): Promise<FirstAndLastChatMessage>
Get first message and last message in entity from MessageTargetEntityType
Parameters
- options: {
  targetEntityId: MessageTargetEntityId;
  targetEntityType: MessageTargetEntityType;
  }
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
Returns Promise<FirstAndLastChatMessage>
- Defined in sfu-extended.ts:1625

getMessageAttachment

getMessageAttachment(attachment): Promise<Attachment>
Load attachment from server

On client side should receive SfuEvent.MESSAGE_ATTACHMENT_STATE with AttachmentStatus to show progress
Parameters
- attachment: AttachmentRequest
Returns Promise<Attachment>
- Defined in sfu-extended.ts:1813

getMessagesCount

getMessagesCount(options): Promise<ChatMessagesCount>
Get messages count in entity from MessageTargetEntityType
Parameters
- options: {
  targetEntityId: MessageTargetEntityId;
  targetEntityType: MessageTargetEntityType;
  }
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
Returns Promise<ChatMessagesCount>
- Defined in sfu-extended.ts:1574

getPublicChannels

getPublicChannels(): Promise<ChatMap>
Returns Promise<ChatMap>
Deprecated
- Defined in sfu-extended.ts:2270

getRolePermissions

getRolePermissions(): Promise<SfuSpaceRolePermissionSection[]>
Returns Promise<SfuSpaceRolePermissionSection[]>
- Defined in sfu-extended.ts:3657

getRoom

getRoom(options): RoomExtended
Parameters
- options: {
  id: string;
  }
  - id: string
Returns RoomExtended
- Defined in sfu-extended.ts:2849

getSendingAttachmentsHandler

getSendingAttachmentsHandler(attachments, messageId): SendingAttachmentsHandler
Get handler for send or cancel sending attachments

Can't cancel sent attachment
Parameters
- attachments: MessageAttachmentData[]
- messageId: string
Returns SendingAttachmentsHandler
- Defined in sfu-extended.ts:1670

getSystemConfig

getSystemConfig(): Promise<SystemConfig>
Get system config (settings)

Used to receive SystemConfig

Returns Promise<SystemConfig>
- Defined in sfu-extended.ts:3779

getUnreadMessagesCount

getUnreadMessagesCount(options): Promise<UnreadMessagesCountEvent>
Get count of unread messages in entity from MessageTargetEntityType
Parameters
- options: {
  targetEntityId: MessageTargetEntityId;
  targetEntityType: MessageTargetEntityType;
  }
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
Returns Promise<UnreadMessagesCountEvent>
- Defined in sfu-extended.ts:1642

getUserCalendar

getUserCalendar(): Promise<Calendar>
Get all user calendar events

Returns Promise<Calendar>
- Defined in sfu-extended.ts:1986

getUserChats

getUserChats(): Promise<ChatMap>
Get chats.

To work with messages in the chat, you need to use MessageTargetEntityType.CHAT

Returns Promise<ChatMap>
- Defined in sfu-extended.ts:2365

getUserEncryptionInfo

getUserEncryptionInfo(): Promise<UserEncryptionInfo>
Returns Promise<UserEncryptionInfo>
- Defined in sfu-extended.ts:2259

getUserInfo

getUserInfo(): Promise<UserInfo>
Get user info

Usually used to display profile info

Returns Promise<UserInfo>
- Defined in sfu-extended.ts:2105

getUserPmiSettings

getUserPmiSettings(): Promise<UserPmiSettings>
Get user pmi settings

Used for create meetings

Returns Promise<UserPmiSettings>
- Defined in sfu-extended.ts:2070

getUserSpaces

getUserSpaces(): Promise<SfuSpace[]>
Get user spaces

If channel meetings were started, user will receive SfuEvent.USER_MEETINGS with MeetingsPreviewEvent.

Returns Promise<SfuSpace[]>
- Defined in sfu-extended.ts:2864

joinSpaceByInviteCode

joinSpaceByInviteCode(inviteCode): Promise<SfuSpace>
Join space by invite code

Space members will receive SpaceEvent.USER_JOINED_TO_SPACE with 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 SfuEvent.USER_MEETINGS with MeetingsPreviewEvent.
Parameters
- inviteCode: string
Returns Promise<SfuSpace>
- Defined in sfu-extended.ts:3056

leaveSpace

leaveSpace(space): Promise<void>
Leave space

Space members will receive SpaceEvent.USER_LEFT_SPACE with 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 MeetingSyncEvent.MEETING_ENDED_SYNC with MeetingEndedSync. If the user was a participant in the meeting, users will receive RoomEvent.EVICTED with EvictedFromRoom.
Parameters
- space: {
  id: string;
  }
  - id: string
Returns Promise<void>
- Defined in sfu-extended.ts:2935

listAttachments

listAttachments(filter): Promise<AttachmentListResult>
List user attachments
Parameters
- filter: {
  offset: number;
  pageSize: number;
  }
  - offset: number
    starting point for retrieving a subset of attachments
  - pageSize: number
    number of items retrieved and displayed per page
Returns Promise<AttachmentListResult>
- Defined in sfu-extended.ts:1594

loadActiveRooms

loadActiveRooms(): Promise<RoomInfo[]>
Get running rooms

Returns Promise<RoomInfo[]>
- Defined in sfu-extended.ts:2805

loadChat

loadChat(chat): Promise<Chat>
Parameters
- chat: {
  id: string;
  }
  - id: string
Returns Promise<Chat>
- Defined in sfu-extended.ts:2373

loadMeetingsHistory

loadMeetingsHistory(params): Promise<MeetingsHistoryEvent>
Load meetings history

Used to load the history of global meetings.

The response returns a MeetingsHistoryEvent with the requested items and the total size.
Parameters
- params: {
      boundaries?: {
          dateMark: number;
          lowerLimit: number;
          upperLimit: number;
      };
      pageRequest?: {
          page: number;
          pageSize: number;
      };
      timeFrame?: {
          end: number;
          limit?: number;
          start: number;
      };
  }
  - Optional boundaries?: {
        dateMark: number;
        lowerLimit: number;
        upperLimit: number;
    }
    - dateMark: number
    - lowerLimit: number
    - upperLimit: number
  - Optional pageRequest?: {
    page: number;
    pageSize: number;
    }
    - page: number
    - pageSize: number
  - Optional timeFrame?: {
        end: number;
        limit?: number;
        start: number;
    }
    - end: number
    - Optional limit?: number
    - start: number
Returns Promise<MeetingsHistoryEvent>
- Defined in sfu-extended.ts:3705

loadMessages

loadMessages(params): Promise<Message[]>
Load messages for Direct chat | Channel | Thread
Parameters
- params: {
      boundaries?: {
          dateMark: number;
          lowerLimit: number;
          upperLimit: number;
      };
      targetEntityId: MessageTargetEntityId;
      targetEntityType: MessageTargetEntityType;
      timeFrame?: {
          end: number;
          limit?: number;
          start: number;
      };
  }
  - Optional boundaries?: {
        dateMark: number;
        lowerLimit: number;
        upperLimit: number;
    }
    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.
    - dateMark: number
    - lowerLimit: number
    - upperLimit: number
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
  - Optional timeFrame?: {
        end: number;
        limit?: number;
        start: number;
    }
    to load by start date to end date. For load all messages used with start = 0, end = -1.
    - end: number
    - Optional limit?: number
    - start: number
Returns Promise<Message[]>
- Defined in sfu-extended.ts:1348

loadMessagesWithMentions

loadMessagesWithMentions(params): Promise<LoadMessagesWithMentionsResult>
Parameters
- params: {
      boundaries?: {
          dateMark: number;
          lowerLimit: number;
          upperLimit: number;
      };
      chatId?: string;
      sortOrder: SortOrder;
      timeFrame?: {
          end: number;
          limit?: number;
          start: number;
      };
      userTag: string;
  }
  - Optional boundaries?: {
        dateMark: number;
        lowerLimit: number;
        upperLimit: number;
    }
    - dateMark: number
    - lowerLimit: number
    - upperLimit: number
  - Optional chatId?: string
  - sortOrder: SortOrder
  - Optional timeFrame?: {
        end: number;
        limit?: number;
        start: number;
    }
    - end: number
    - Optional limit?: number
    - start: number
  - userTag: string
Returns Promise<LoadMessagesWithMentionsResult>
Deprecated
- Defined in sfu-extended.ts:2332

logout

logout(): Promise<void>
Logout from app

Returns Promise<void>
- Defined in sfu-extended.ts:1320

markMessageRead

markMessageRead(msg): Promise<LastReadMessageUpdated>
Mark message as read in a Direct chat | Channel | Thread

In targetEntity will change lastReadMessageId and lastReadMessageDate

All unread messages with a Message.date earlier than or equal to the marked one will be marked as read. The sender of each message will receive SfuEvent.UPDATE_MESSAGES_DELIVERY_STATUS with UpdateMessagesDeliveryStatusEvent and Message.deliveryStatus will be changed at the server side to DeliveryStatus.READ.
Parameters
- msg: {
      id: string;
      targetEntityId: MessageTargetEntityId;
      targetEntityType: MessageTargetEntityType;
  }
  - id: string
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
Returns Promise<LastReadMessageUpdated>
- Defined in sfu-extended.ts:1517

markMessageUnread

markMessageUnread(msg): Promise<LastReadMessageUpdated>
Mark message as unread in a Direct chat | Channel | Thread

In targetEntity will change lastReadMessageId and lastReadMessageDate. Message.deliveryStatus

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 SfuEvent.UPDATE_MESSAGES_DELIVERY_STATUS with UpdateMessagesDeliveryStatusEvent and Message.deliveryStatus will be changed at the server side to DeliveryStatus.READ.
Parameters
- msg: {
      id: string;
      targetEntityId: MessageTargetEntityId;
      targetEntityType: MessageTargetEntityType;
  }
  - id: string
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
Returns Promise<LastReadMessageUpdated>
- Defined in sfu-extended.ts:1549

moveSpaceChannel

moveSpaceChannel(channel): Promise<SpaceChannelMoved>
Move space channel

Channel members will receive SpaceEvent.SPACE_CHANNEL_MOVED with SpaceChannelMoved
Parameters
- channel: {
      categoryId: string;
      channelId: string;
      spaceId: string;
  }
  - categoryId: string
    Specify the identifier of the category to which you want to move the channel, or an empty string to leave the channel uncategorized.
  - channelId: string
  - spaceId: string
Returns Promise<SpaceChannelMoved>
- Defined in sfu-extended.ts:3208

muteChannel

muteChannel(options): Promise<ChannelMuted>
Mute channel
Parameters
- options: {
      channelId: string;
      muteTime?: number;
      mutedIndefinitely?: boolean;
      spaceId: string;
  }
  - channelId: string
  - Optional muteTime?: number
    – the duration for which the sound is muted. The final event will contain MuteSettings.mutedUntil, which is the current time plus the specified duration.
  - Optional mutedIndefinitely?: boolean
    – indicates whether the sound is muted indefinitely.
    
    Returns ChannelMuted, and other connected devices will also receive this event for synchronization.
  - spaceId: string
Returns Promise<ChannelMuted>
- Defined in sfu-extended.ts:3276

muteChat

muteChat(options): Promise<ChatMuted>
Mute chat
Parameters
- options: {
      id: string;
      muteTime?: number;
      mutedIndefinitely?: boolean;
  }
  - id: string
  - Optional muteTime?: number
    – the duration for which the sound is muted. The final event will contain MuteSettings.mutedUntil, which is the current time plus the specified duration.
  - Optional mutedIndefinitely?: boolean
    – indicates whether the sound is muted indefinitely.
    
    Returns ChatMuted, and other connected devices will also receive this event for synchronization.
Returns Promise<ChatMuted>
- Defined in sfu-extended.ts:2499

muteSpace

muteSpace(options): Promise<SpaceMuted>
Mute space
Parameters
- options: {
      muteTime?: number;
      mutedIndefinitely?: boolean;
      spaceId: string;
  }
  - Optional muteTime?: number
    – the duration for which the sound is muted. The final event will contain MuteSettings.mutedUntil, which is the current time plus the specified duration.
  - Optional mutedIndefinitely?: boolean
    – indicates whether the sound is muted indefinitely.
    
    Returns SpaceMuted, and other connected devices will also receive this event for synchronization.
  - spaceId: string
Returns Promise<SpaceMuted>
- Defined in sfu-extended.ts:2976

muteThread

muteThread(options): Promise<ThreadMuted>
Mute thread
Parameters
- options: {
      channelId: string;
      muteTime?: number;
      mutedIndefinitely?: boolean;
      spaceId: string;
      threadId: string;
  }
  - channelId: string
  - Optional muteTime?: number
    – the duration for which the sound is muted. The final event will contain MuteSettings.mutedUntil, which is the current time plus the specified duration.
  - Optional mutedIndefinitely?: boolean
    – indicates whether the sound is muted indefinitely.
    
    Returns ThreadMuted, and other connected devices will also receive this event for synchronization.
  - spaceId: string
  - threadId: string
Returns Promise<ThreadMuted>
- Defined in sfu-extended.ts:3472

off

off(event, callback): SfuExtended
Parameters
- event: EventUnion
- callback: ((arg0) => void)
  - - (arg0): void
    - Parameters
      arg0: NotifyUnion
      Returns void
Returns SfuExtended
- Defined in sfu-extended.ts:3958

on

on(event, callback): SfuExtended
Parameters
- event: EventUnion
- callback: ((arg0) => void)
  - - (arg0): void
    - Parameters
      arg0: NotifyUnion
      Returns void
Returns SfuExtended
- Defined in sfu-extended.ts:3953

rejectFriendInvite

rejectFriendInvite(invite): Promise<FriendInviteDeleted>
Reject friend invite

Promise will resolve with SfuEvent.INCOMING_FRIEND_INVITE_DELETED with FriendInviteDeleted. Outgoing friend invite will not delete.
Parameters
- invite: {
  inviteId: string;
  }
  - inviteId: string
Returns Promise<FriendInviteDeleted>
- Defined in sfu-extended.ts:1948

removeCalendarEvent

removeCalendarEvent(event): Promise<CalendarEvent>
Parameters
- event: {
  id: string;
  }
  - id: string
Returns Promise<CalendarEvent>
- Defined in sfu-extended.ts:2023

removeChannelSendPermissionListMember

removeChannelSendPermissionListMember(channel): Promise<UserSpecificChatInfo>
Parameters
- channel: {
  id: string;
  member: string;
  }
  - id: string
  - member: string
Returns Promise<UserSpecificChatInfo>
Deprecated
- Defined in sfu-extended.ts:2633

removeChatFromFavourites

removeChatFromFavourites(chat): Promise<UserSpecificChatInfo>
Used to change UserSpecificChatInfo.favourite to false
Parameters
- chat: {
  id: string;
  }
  - id: string
Returns Promise<UserSpecificChatInfo>
- Defined in sfu-extended.ts:2680

removeFriend

removeFriend(friend): Promise<void>
Remove friend

Users will receive SfuEvent.CONTACT_UPDATED with ContactUpdated if they have mutual space channels or direct chats. Will receive SfuEvent.CONTACT_DELETED with ContactDeleted if haven't.
Parameters
- friend: {
  userId: string;
  }
  - userId: string
Returns Promise<void>
- Defined in sfu-extended.ts:1894

removeMeetingFromHistory

removeMeetingFromHistory(id): Promise<void>
Remove meeting from history

Used to remove meeting from history. Any user can remove it. This does not affect other users' history in any way.
Parameters
- id: string
Returns Promise<void>
- Defined in sfu-extended.ts:3733

removeMeetingRecord

removeMeetingRecord(options): Promise<void>
Removes the meeting recording (video).

The right to remove is granted to the following roles: In global meetings – the meeting owner In channel meetings – the space owner In group direct chats – the chat creator In personal direct chats – no one

Users will receive MeetingRecordDeleted for global meetings and MessageEdited for others, because it's system message
Parameters
- options: {
      meetingHistoryItemId: string;
      meetingId?: string;
      meetingType: ConferenceType;
      recordId: string;
      spaceId?: string;
  }
  - meetingHistoryItemId: string
  - Optional meetingId?: string
  - meetingType: ConferenceType
  - recordId: string
  - Optional spaceId?: string
Returns Promise<void>
- Defined in sfu-extended.ts:3754

removeMemberFromChat

removeMemberFromChat(chat): Promise<UserSpecificChatInfo>
Remove a member to chat

Chat members will receive SfuEvent.CHAT_UPDATED with UserSpecificChatInfo

If a direct meeting was started and user was , user will receive MeetingSyncEvent.MEETING_ENDED_SYNC with MeetingEndedSync. If the user was a participant in the meeting, users will receive RoomEvent.EVICTED with EvictedFromRoom.
Parameters
- chat: {
  id: string;
  member: string;
  }
  - id: string
  - member: string
    user will receive SfuEvent.CHAT_DELETED with UserSpecificChatInfo.
Returns Promise<UserSpecificChatInfo>
- Defined in sfu-extended.ts:2571

removeMemberFromThread

removeMemberFromThread(options): Promise<RemovedMemberFromThread>
Remove member from thread

For space owner/thread creator only

Thread members will receive SpaceEvent.REMOVED_MEMBER_FROM_THREAD with RemovedMemberFromThread

The removed member will receive SpaceEvent.SPACE_THREAD_DELETED with SpaceThreadDeleted
Parameters
- options: {
      channelId: string;
      member: string;
      spaceId: string;
      threadId: string;
  }
  - channelId: string
  - member: string
  - spaceId: string
  - threadId: string
Returns Promise<RemovedMemberFromThread>
- Defined in sfu-extended.ts:3398

removeReactionOnMessage

removeReactionOnMessage(msg): Promise<AddedRemovedReactionOnMessage>
Remove reaction on message in a Direct chat | Channel | Thread

Members will receive SfuEvent.REACTION_ON_MESSAGE_REMOVED with AddedRemovedReactionOnMessage
Parameters
- msg: {
      messageId: string;
      reaction: string;
      targetEntityId: MessageTargetEntityId;
      targetEntityType: MessageTargetEntityType;
  }
  - messageId: string
  - reaction: string
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
Returns Promise<AddedRemovedReactionOnMessage>
- Defined in sfu-extended.ts:1490

removeRoleFromMember

removeRoleFromMember(options): Promise<RemovedRoleFromMember>
Remove space role from member

For space owner/user that has permission to manage roles

Space members will receive SpaceEvent.REMOVED_ROLE_FROM_MEMBER with RemovedRoleFromMember

Participant from whom this role will be removed will receive SpaceEvent.SPACE_CHANNEL_DELETED with SpaceChannelDeleted for each channel they were part of because of this role. Other members of these channels will receive SpaceEvent.SPACE_CHANNEL_UPDATED with SpaceChannelUpdated.
Parameters
- options: {
      memberId: string;
      roleId: string;
      spaceId: string;
  }
  - memberId: string
  - roleId: string
  - spaceId: string
Returns Promise<RemovedRoleFromMember>
- Defined in sfu-extended.ts:3641

removeUser

removeUser(options): Promise<void>
Remove user (internal using)
Parameters
- options: {
      id: string;
      timeout?: number;
      url: string;
  }
  - id: string
  - Optional timeout?: number
  - url: string
Returns Promise<void>
- Defined in sfu-extended.ts:1267

renameChat

renameChat(chat): Promise<void>
Update chat

Chat members will receive SfuEvent.CHAT_UPDATED with UserSpecificChatInfo
Parameters
- chat: {
  id: string;
  name: string;
  }
  - id: string
  - name: string
Returns Promise<void>
- Defined in sfu-extended.ts:2459

resetPassword

resetPassword(options): Promise<ResetPasswordHandler>
Reset password

When calls, returns ResetPasswordHandler then need to call ResetPasswordHandler.resetPassword to reset the password
Parameters
- options: {
      email: string;
      timeout?: number;
      url: string;
  }
  - email: string
  - Optional timeout?: number
  - url: string
Returns Promise<ResetPasswordHandler>
- Defined in sfu-extended.ts:1165

revokeFriendInvite

revokeFriendInvite(invite): Promise<FriendInviteDeleted>
Revoke friend invite

Users will receive SfuEvent.OUTGOING_FRIEND_INVITE_DELETED and SfuEvent.INCOMING_FRIEND_INVITE_DELETED with FriendInviteDeleted.
Parameters
- invite: {
  inviteId: string;
  }
  - inviteId: string
Returns Promise<FriendInviteDeleted>
- Defined in sfu-extended.ts:1911

revokeSpaceInvite

revokeSpaceInvite(options): Promise<SfuSpaceInvite>
Removing the space invite
Parameters
- options: {
  inviteCode: string;
  spaceId: string;
  }
  - inviteCode: string
  - spaceId: string
Returns Promise<SfuSpaceInvite>
- Defined in sfu-extended.ts:3034

roomAvailable

roomAvailable(options): Promise<RoomExtended>
Check and get an available room.

To join, you need to use room.join()
Parameters
- options: {
      id: string;
      nickname?: string;
      pin?: string;
  }
  - id: string
  - Optional nickname?: string
  - Optional pin?: string
Returns Promise<RoomExtended>
- Defined in sfu-extended.ts:2817

roomExists

roomExists(options): Promise<void>
Checks for the existence of a running room.
Parameters
- options: {
  id: string;
  pin?: string;
  }
  - id: string
  - Optional pin?: string
Returns Promise<void>
- Defined in sfu-extended.ts:2835

searchChatMessages

searchChatMessages(params): Promise<Message[]>
Parameters
- params: {
      chatId: string;
      limit?: number;
      searchId?: string;
      searchString: string;
  }
  - chatId: string
  - Optional limit?: number
  - Optional searchId?: string
  - searchString: string
Returns Promise<Message[]>
Deprecated
- Defined in sfu-extended.ts:2281

searchMessageAttachments

searchMessageAttachments(params): Promise<MessageAttachmentsSearchResult>
Parameters
- params: {
      attachmentsType?: MessageAttachmentMediaType;
      boundaries?: {
          dateMark: number;
          lowerLimit: number;
          upperLimit: number;
      };
      chatId?: string;
      from?: string;
      searchString?: string;
      sortOrder: SortOrder;
      timeFrame?: {
          end: number;
          limit?: number;
          start: number;
      };
  }
  - Optional attachmentsType?: MessageAttachmentMediaType
  - Optional boundaries?: {
        dateMark: number;
        lowerLimit: number;
        upperLimit: number;
    }
    - dateMark: number
    - lowerLimit: number
    - upperLimit: number
  - Optional chatId?: string
  - Optional from?: string
  - Optional searchString?: string
  - sortOrder: SortOrder
  - Optional timeFrame?: {
        end: number;
        limit?: number;
        start: number;
    }
    - end: number
    - Optional limit?: number
    - start: number
Returns Promise<MessageAttachmentsSearchResult>
Deprecated
- Defined in sfu-extended.ts:2297

sendMessage

sendMessage(msg): Promise<MessageStatus>
Send a message to a Direct chat | Channel | Thread

Members will receive SfuEvent.MESSAGE with Message
Parameters
- msg: {
      attachments?: MessageAttachment[];
      body?: string;
      parentId?: string;
      targetEntityId: MessageTargetEntityId;
      targetEntityType: MessageTargetEntityType;
      to?: string;
  }
  - Optional attachments?: MessageAttachment[]
  - Optional body?: string
  - Optional parentId?: string
    to send reply message
  - targetEntityId: MessageTargetEntityId
  - targetEntityType: MessageTargetEntityType
  - Optional to?: string
    to send a private message
Returns Promise<MessageStatus>
- Defined in sfu-extended.ts:1377

server

server(): string
Returns string
- Defined in sfu-extended.ts:3945

signUp

signUp(options): Promise<SignUpStatus>
Sign up for new users

Works in a separate connection
Parameters
- options: {
      email: string;
      password: string;
      timeout?: number;
      url: string;
      username: string;
  }
  - email: string
  - password: string
  - Optional timeout?: number
  - url: string
  - username: string
Returns Promise<SignUpStatus>
- Defined in sfu-extended.ts:1031

state

state(): State
Returns State
- Defined in sfu-extended.ts:3949

unmuteChannel

unmuteChannel(options): Promise<ChannelUnmuted>
Unmute channel

SfuSpaceChannel.muteSettings wil be null - that means the channel is not muted.

Returns ChannelUnmuted, and other connected devices will also receive this event for synchronization.
Parameters
- options: {
  channelId: string;
  spaceId: string;
  }
  - channelId: string
  - spaceId: string
Returns Promise<ChannelUnmuted>
- Defined in sfu-extended.ts:3301

unmuteChat

unmuteChat(options): Promise<ChatUnmuted>
Unmute chat

UserSpecificChatInfo.muteSettings wil be null - that means the chat is not muted.

Returns ChatUnmuted, and other connected devices will also receive this event for synchronization.
Parameters
- options: {
  id: string;
  }
  - id: string
Returns Promise<ChatUnmuted>
- Defined in sfu-extended.ts:2522

unmuteSpace

unmuteSpace(options): Promise<SpaceUnmuted>
Unmute space

SfuSpace.muteSettings wil be null - that means the space is not muted.

Returns SpaceUnmuted, and other connected devices will also receive this event for synchronization.
Parameters
- options: {
  spaceId: string;
  }
  - spaceId: string
Returns Promise<SpaceUnmuted>
- Defined in sfu-extended.ts:2999

unmuteThread

unmuteThread(options): Promise<ThreadUnmuted>
Unmute thread

SfuSpaceThread.muteSettings wil be null - that means the thread is not muted.

Returns ThreadUnmuted, and other connected devices will also receive this event for synchronization.
Parameters
- options: {
      channelId: string;
      spaceId: string;
      threadId: string;
  }
  - channelId: string
  - spaceId: string
  - threadId: string
Returns Promise<ThreadUnmuted>
- Defined in sfu-extended.ts:3499

updateActivityStatus

updateActivityStatus(isActive): Promise<void>
Update user activity

Working with selected PresenceStatus.ONLINE by updatePresenceStatus. Does not work with other statuses.

The user client that called this method will receive UserInfoChangedEvent with PresenceStatus.ONLINE or PresenceStatus.IDLE. Other user clients will not receive events.

{@param isActive} = false: If the user hasn't other connected active clients then user contacts will receive UserPresenceStatusUpdated with PresenceStatus.IDLE. If the user has other connected active clients then user contacts will not receive events.

{@param isActive} = true: If all user clients was inactive then user contacts will receive UserPresenceStatusUpdated with PresenceStatus.ONLINE. If the user has at least one active connected client, then the contacts will not receive any events.
Parameters
- isActive: boolean
Returns Promise<void>
- Defined in sfu-extended.ts:2217

updateCalendarEvent

updateCalendarEvent(event): Promise<CalendarEvent>
Update calendar event
Parameters
- event: {
      accessCode?: string;
      allowJoinAtAnyTime: boolean;
      description: string;
      end: number;
      id: string;
      ownerVideo: boolean;
      participantVideo: boolean;
      recurring: boolean;
      start: number;
      title: string;
      useLocalAutoRecord: boolean;
      useMuteAudioOnJoin: boolean;
      usePMI: boolean;
      waitingRoom: boolean;
  }
  - Optional accessCode?: string
  - allowJoinAtAnyTime: boolean
  - description: string
  - end: number
  - id: string
  - ownerVideo: boolean
  - participantVideo: boolean
  - recurring: boolean
  - start: number
  - title: string
  - useLocalAutoRecord: boolean
  - useMuteAudioOnJoin: boolean
  - usePMI: boolean
    if true then user PMI settings will be updated and user will receive SfuEvent.UPDATE_USER_PMI_SETTINGS with UserPmiSettings
  - waitingRoom: boolean
Returns Promise<CalendarEvent>
- Defined in sfu-extended.ts:2040

updateChannelNotificationSettings

updateChannelNotificationSettings(options): Promise<ChannelNotificationSettingsUpdated>
Update channel notification settings

Used to modify and store channel notification settings specified in SfuSpaceChannel.notificationSettings.

Returns ChannelNotificationSettingsUpdated, and other connected devices will also receive this event for synchronization.
Parameters
- options: {
      channelId: string;
      spaceId: string;
      value: NotificationMode;
  }
  - channelId: string
  - spaceId: string
  - value: NotificationMode
Returns Promise<ChannelNotificationSettingsUpdated>
- Defined in sfu-extended.ts:3252

updateChannelSendPolicy

updateChannelSendPolicy(channel): Promise<UserSpecificChatInfo>
Parameters
- channel: {
  channelSendPolicy: ChannelSendPolicy;
  id: string;
  }
  - channelSendPolicy: ChannelSendPolicy
  - id: string
Returns Promise<UserSpecificChatInfo>
Deprecated
- Defined in sfu-extended.ts:2585

updateChatConfiguration

updateChatConfiguration(chat): Promise<UserSpecificChatInfo>
Parameters
- chat: {
      allowedToAddExternalUser?: boolean;
      channelSendPolicy?: ChannelSendPolicy;
      id: string;
      sendPermissionList?: string[];
      type?: ChatType;
  }
  - Optional allowedToAddExternalUser?: boolean
  - Optional channelSendPolicy?: ChannelSendPolicy
  - id: string
  - Optional sendPermissionList?: string[]
  - Optional type?: ChatType
Returns Promise<UserSpecificChatInfo>
Deprecated
- Defined in sfu-extended.ts:2650

updateChatHiding

updateChatHiding(chat): Promise<UserSpecificChatInfo>
Used to change UserSpecificChatInfo.hidden
Parameters
- chat: {
  hidden: boolean;
  id: string;
  }
  - hidden: boolean
  - id: string
Returns Promise<UserSpecificChatInfo>
- Defined in sfu-extended.ts:2693

updateChatIcon

updateChatIcon(options): Promise<string>
Update chat icon

Used to update direct chat icon.

Chat members will receive ChatIconUpdated with ChatIconUpdated.icon as download url.

Returns download url or null if removed.
Parameters
- options: {
      icon?: File;
      id: string;
      remove?: boolean;
  }
  - Optional icon?: File
  - id: string
  - Optional remove?: boolean
Returns Promise<string>
- Defined in sfu-extended.ts:3918

`Private` updateChatIconRequest

updateChatIconRequest(options): Promise<string>
Parameters
- options: {
      id: string;
      name?: string;
      remove?: boolean;
      size?: number;
  }
  - id: string
  - Optional name?: string
  - Optional remove?: boolean
  - Optional size?: number
Returns Promise<string>
- Defined in sfu-extended.ts:3891

updateChatNotificationSettings

updateChatNotificationSettings(options): Promise<ChatNotificationSettingsUpdated>
Update chat notification settings

Used to modify and store chat notification settings specified in UserSpecificChatInfo.notificationSettings.

Returns ChatNotificationSettingsUpdated, and other connected devices will also receive this event for synchronization.
Parameters
- options: {
  id: string;
  value: NotificationMode;
  }
  - id: string
  - value: NotificationMode
Returns Promise<ChatNotificationSettingsUpdated>
- Defined in sfu-extended.ts:2477

updateChatReceivePolicy

updateChatReceivePolicy(channel): Promise<UserSpecificChatInfo>
Parameters
- channel: {
  chatReceivePolicy: ChatReceivePolicy;
  id: string;
  }
  - chatReceivePolicy: ChatReceivePolicy
  - id: string
Returns Promise<UserSpecificChatInfo>
- Defined in sfu-extended.ts:2599

updateContactVolume

updateContactVolume(options): Promise<ContactPersonalSettings>
Update contact volume

Used to change and store the contact's volume in meetings.
Parameters
- options: {
  userId: string;
  value: number;
  }
  - userId: string
  - value: number
    whole number
    
    Returns ContactPersonalSettings, and other connected devices will receive ContactPersonalSettingsUpdated for synchronization.
Returns Promise<ContactPersonalSettings>
- Defined in sfu-extended.ts:1969

updatePresenceStatus

updatePresenceStatus(status): Promise<void>
Update presence status

Friends and users with whom there are mutual space channels or direct chats will receive SfuEvent.USER_PRESENCE_STATUS_UPDATED with UserPresenceStatusUpdated. The selected status is saved and will persist across subsequent connects. It can be retrieved using the getUserInfo.
Parameters
- status: PresenceStatus
Returns Promise<void>
- Defined in sfu-extended.ts:2190

updateSpaceCategory

updateSpaceCategory(options): Promise<void>
Delete space category

For space owner/category creator/user that has permission to manage categories

Space members will receive SpaceEvent.SPACE_CATEGORY_UPDATED with SpaceCategoryUpdated
Parameters
- options: {
      categoryId: string;
      name: string;
      spaceId: string;
  }
  - categoryId: string
  - name: string
  - spaceId: string
Returns Promise<void>
- Defined in sfu-extended.ts:3115

updateSpaceChannel

updateSpaceChannel(channel): Promise<SpaceChannelUpdated>
Update space channel

For space owner/user that has permission to manage channels

Channel members will receive SpaceEvent.SPACE_CHANNEL_UPDATED with SpaceChannelUpdated In the private channel added members will receive SpaceEvent.NEW_SPACE_CHANNEL with NewSpaceChannelEvent. If the channel meeting was started, added members will receive SfuEvent.NEW_MEETING with NewMeeting.

In the private channel deleted members will receive SpaceEvent.SPACE_CHANNEL_DELETED with SpaceChannelDeleted If the channel meeting was started, deleted members will receive MeetingSyncEvent.MEETING_ENDED_SYNC with MeetingEndedSync. If the deleted user was a participant in the meeting, users will receive RoomEvent.EVICTED with EvictedFromRoom.
Parameters
- channel: {
      channelId: string;
      isPrivate: boolean;
      members?: string[];
      name: string;
      roles?: string[];
      spaceId: string;
  }
  - channelId: string
  - isPrivate: boolean
  - Optional members?: string[]
    used to create a private channel. Array of member ids or empty array.
  - name: string
  - Optional roles?: string[]
    used to create a private channel. Array of role ids or empty array.
  - spaceId: string
Returns Promise<SpaceChannelUpdated>
- Defined in sfu-extended.ts:3179

updateSpaceIcon

updateSpaceIcon(options): Promise<string>
Update space icon

Used to update space icon.

Space members will receive SpaceOverviewUpdated with SpaceOverviewUpdated.icon as download url.

Returns download url or null if removed.
Parameters
- options: {
      icon?: File;
      id: string;
      remove?: boolean;
  }
  - Optional icon?: File
  - id: string
  - Optional remove?: boolean
Returns Promise<string>
- Defined in sfu-extended.ts:3815

`Private` updateSpaceIconRequest

updateSpaceIconRequest(options): Promise<string>
Parameters
- options: {
      id: string;
      name?: string;
      remove?: boolean;
      size?: number;
  }
  - id: string
  - Optional name?: string
  - Optional remove?: boolean
  - Optional size?: number
Returns Promise<string>
- Defined in sfu-extended.ts:3788

updateSpaceNickname

updateSpaceNickname(options): Promise<UserSpaceNicknameUpdated>
Update nickname in the space Updates a user's nickname in the space.

A custom nickname, if set, takes precedence over the user's global nickname. If no custom nickname is provided (or an empty string is passed), the user's global nickname must be displayed.

To remove a previously set the custom nickname and revert to the global one, pass an empty string.
Parameters
- options: {
      nickname: string;
      spaceId: string;
      userId?: string;
  }
  - nickname: string
  - spaceId: string
  - Optional userId?: string
    Optional. The ID of the user whose nickname is being updated. If this field is omitted or set to the caller's own ID, the caller's nickname is updated. The space owner can update anyone's nickname by specifying user ID. If a non-owner attempts to update another user's nickname, a SpaceError.UPDATE_NICKNAME_ACCESS_RIGHTS_ERROR is thrown. All space members receive a SpaceEvent.USER_SPACE_NICKNAME_UPDATED event with a UserSpaceNicknameUpdated payload when the nickname is updated.
Returns Promise<UserSpaceNicknameUpdated>
- Defined in sfu-extended.ts:3681

updateSpaceNotificationSettings

updateSpaceNotificationSettings(options): Promise<SpaceNotificationSettingsUpdated>
Update space notification settings

Used to modify and store space notification settings specified in SfuSpace.notificationSettings.

Returns SpaceNotificationSettingsUpdated, and other connected devices will also receive this event for synchronization.
Parameters
- options: {
  spaceId: string;
  value: NotificationMode;
  }
  - spaceId: string
  - value: NotificationMode
Returns Promise<SpaceNotificationSettingsUpdated>
- Defined in sfu-extended.ts:2954

updateSpaceOverview

updateSpaceOverview(space): Promise<void>
Update space overview

Space members will receive SpaceEvent.SPACE_OVERVIEW_UPDATED with SpaceOverviewUpdated
Parameters
- space: {
  id: string;
  name: string;
  }
  - id: string
  - name: string
Returns Promise<void>
- Defined in sfu-extended.ts:2892

updateSpaceRole

updateSpaceRole(role): Promise<SpaceRoleUpdated>
Update space role

For space owner/user that has permission to manage roles

Space members will receive SpaceEvent.SPACE_ROLE_UPDATED with SpaceRoleUpdated

On the client side, a new role must be added to the participants listed in the SpaceRoleUpdated.membersForAddRole and must be removed from participants listed in the SpaceRoleUpdated.membersForDeleteRole

Participants from whom this role will be removed will receive SpaceEvent.SPACE_CHANNEL_DELETED with SpaceChannelDeleted for each channel they were part of because of this role.

Participants who are assigned this role will receive SpaceEvent.NEW_SPACE_CHANNEL with 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 SpaceEvent.SPACE_CHANNEL_UPDATED with SpaceChannelUpdated for each channel that has this role in its access rights.
Parameters
- role: {
      color: string;
      members: string[];
      name: string;
      permissions: string[];
      roleId: string;
      spaceId: string;
  }
  - color: string
  - members: string[]
  - name: string
  - permissions: string[]
  - roleId: string
  - spaceId: string
Returns Promise<SpaceRoleUpdated>
- Defined in sfu-extended.ts:3560

updateSpaceThread

updateSpaceThread(options): Promise<void>
Update space thread

For space owner/thread creator

Thread members will receive SpaceEvent.SPACE_THREAD_UPDATED with SpaceThreadUpdated
Parameters
- options: {
      channelId: string;
      name: string;
      spaceId: string;
      threadId: string;
  }
  - channelId: string
  - name: string
  - spaceId: string
  - threadId: string
Returns Promise<void>
- Defined in sfu-extended.ts:3345

updateThreadNotificationSettings

updateThreadNotificationSettings(options): Promise<ThreadNotificationSettingsUpdated>
Update thread notification settings

Used to modify and store thread notification settings specified in SfuSpaceThread.notificationSettings.

Returns ThreadNotificationSettingsUpdated, and other connected devices will also receive this event for synchronization.
Parameters
- options: {
      channelId: string;
      spaceId: string;
      threadId: string;
      value: NotificationMode;
  }
  - channelId: string
  - spaceId: string
  - threadId: string
  - value: NotificationMode
Returns Promise<ThreadNotificationSettingsUpdated>
- Defined in sfu-extended.ts:3446

updateUserIcon

updateUserIcon(options): Promise<string>
Update user avatar

Used to update user avatar.

User will receive UserInfoChangedEvent and ContactUpdated with self. User's contacts will receive ContactUpdated

Returns download url or null if removed.
Parameters
- options: {
  icon?: File;
  remove?: boolean;
  }
  - Optional icon?: File
  - Optional remove?: boolean
Returns Promise<string>
- Defined in sfu-extended.ts:3867

`Private` updateUserIconRequest

updateUserIconRequest(options): Promise<string>
Parameters
- options: {
      name?: string;
      remove?: boolean;
      size?: number;
  }
  - Optional name?: string
  - Optional remove?: boolean
  - Optional size?: number
Returns Promise<string>
- Defined in sfu-extended.ts:3841

updateUserPmiSettings

updateUserPmiSettings(settings): Promise<UserPmiSettings>
Update user pmi settings
Parameters
- settings: {
      accessCode: string;
      allowJoinAtAnyTime: boolean;
      useAccessCode: boolean;
      useLocalAutoRecord: boolean;
      useMuteAudioOnJoin: boolean;
      useOwnerVideo: boolean;
      useParticipantsVideo: boolean;
      useWaitingRoom: boolean;
  }
  - accessCode: string
  - allowJoinAtAnyTime: boolean
  - useAccessCode: boolean
  - useLocalAutoRecord: boolean
  - useMuteAudioOnJoin: boolean
  - useOwnerVideo: boolean
  - useParticipantsVideo: boolean
  - useWaitingRoom: boolean
Returns Promise<UserPmiSettings>
- Defined in sfu-extended.ts:2081

user

user(): {
    authToken: string;
    email: string;
    nickname: string;
    pmi: string;
    username: string;
    webRTCMetricsServerDescription?: RTCMetricsServerDescription;
}
Returns {
    authToken: string;
    email: string;
    nickname: string;
    pmi: string;
    username: string;
    webRTCMetricsServerDescription?: RTCMetricsServerDescription;
}
- authToken: string
- email: string
- nickname: string
- pmi: string
- username: string
- Optional webRTCMetricsServerDescription?: RTCMetricsServerDescription
- Defined in sfu-extended.ts:3941

`Static` fromUTF8ArrayToStr

fromUTF8ArrayToStr(data): string
Parameters
- data: Uint8Array
Returns string
- Defined in sfu-extended.ts:4051

`Static` generateAttachmentId

generateAttachmentId(): string
This method is recommended for using to generate attachment id before sending. Sending and downloading attachments may not work with other generating options.

Returns string
string of 36 ASCII characters
- Defined in sfu-extended.ts:1661

`Static` strToUTF8Array

strToUTF8Array(str): number[]
Parameters
- str: string
Returns number[]
- Defined in sfu-extended.ts:4027

Class SfuExtended

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SfuExtended

Properties

Private #_server

Private #_state

Private #_url

Private #_user

Type declaration

authToken: string

email: string

nickname: string

pmi: string

username: string

Optional webRTCMetricsServerDescription?: RTCMetricsServerDescription

Private #attachmentsTransferManager

Private #binaryChunkSize

Private #connection

Private #logger

Private #loggerPrefix

Private #notifier

Private #resetPasswordId

Private #rooms

Type declaration

[key: string]: RoomExtended

Private #signUpId

Private #uploadingAttachmentState

Methods

Private #checkAuthenticated

Returns void

Private #createConnection

Returns void

Private #emmitAction

Parameters

Returns void

Private #emmitBinaryAction

Parameters

Returns void

Private #getConnectionConfigForAnonymousUser

Parameters

Returns { appName: InternalApi; custom: { nickname: string; password: string; username: string; }; timeout: number; url: string; }

appName: InternalApi

custom: { nickname: string; password: string; username: string; }

nickname: string

password: string

username: string

timeout: number

url: string

Private #getConnectionConfigForExamples

Parameters

Returns { appName: InternalApi; custom: { nickname: string; password: string; username: string; }; timeout: number; url: string; }

appName: InternalApi

custom: { nickname: string; password: string; username: string; }

nickname: string

password: string

username: string

timeout: number

url: string

acceptFriendInvite

Parameters

inviteId: string

Returns Promise<Contact>

addCalendarEvent

Parameters

Optional accessCode?: string

allowJoinAtAnyTime: boolean

description: string

end: number

ownerVideo: boolean

participantVideo: boolean

recurring: boolean

start: number

title: string

useLocalAutoRecord: boolean

`Private` #_server

`Private` #_state

`Private` #_url

`Private` #_user

`Optional` webRTCMetricsServerDescription?: RTCMetricsServerDescription

`Private` #attachmentsTransferManager

`Private` #binaryChunkSize

`Private` #connection

`Private` #logger

`Private` #loggerPrefix

`Private` #notifier

`Private` #resetPasswordId

`Private` #rooms

`Private` #signUpId

`Private` #uploadingAttachmentState

`Private` #checkAuthenticated

`Private` #createConnection

`Private` #emmitAction

`Private` #emmitBinaryAction

`Private` #getConnectionConfigForAnonymousUser

Returns {
appName: InternalApi;
custom: {
nickname: string;
password: string;
username: string;
};
timeout: number;
url: string;
}

custom: {
nickname: string;
password: string;
username: string;
}

`Private` #getConnectionConfigForExamples

Returns {
appName: InternalApi;
custom: {
nickname: string;
password: string;
username: string;
};
timeout: number;
url: string;
}

custom: {
nickname: string;
password: string;
username: string;
}

`Optional` accessCode?: string

`Optional` encryptedChatPassword?: string

`Optional` iv?: string

`Optional` salt?: string

`Optional` verificationHash?: string