Class ChatRoom

Hierarchy (View Summary)

Listenable
- ChatRoom

Constructors

constructor

new ChatRoom(
    connection: XmppConnection,
    jid: string,
    password: string,
    xmpp: XMPP,
    options?: IChatRoomOptions,
): ChatRoom
Parameters
- connection: XmppConnection
  The XMPP connection instance.
- jid: string
- password: string
- xmpp: XMPP
- Optionaloptions: IChatRoomOptions
  - disableFocus
    when set to {@code false} will not invite Jicofo into the room.
  - disableDiscoInfo
    when set to {@code false} will skip disco info. This is intended to be used only for lobby rooms.
  - enableLobby
    when set to {@code false} will skip creating lobby room.
  - hiddenFromRecorderFeatureEnabled
    when set to {@code true} we will check identity tag for node presence.
Returns ChatRoom
Overrides Listenable.constructor
- Defined in modules/xmpp/ChatRoom.ts:279

Properties

connection

connection: XmppConnection

connectionTimes

connectionTimes: Record<string, number>

focusMucJid

focusMucJid: string

joined

joined: boolean

`Optional`membersOnlyEnabled

membersOnlyEnabled?: boolean

myroomjid

myroomjid: string

presMap

presMap: IPresenceMap

role

role: string

roomjid

roomjid: string

transcriptionStatus

transcriptionStatus: string

`Optional`visitorsSupported

visitorsSupported?: boolean

xmpp

xmpp: XMPP

Methods

addCancellableListener

addCancellableListener(eventName: string, listener: EventListener): () => void
Adds new cancellable listener.
Parameters
- eventName: string
  the name of the event
- listener: EventListener
  the listener.
Returns () => void
- The unsubscribe function.
Inherited from Listenable.addCancellableListener
- Defined in modules/util/Listenable.ts:73

addEventListener

addEventListener(eventId: string, handler: EventListener): void
Alias for on method.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
Inherited from Listenable.addEventListener
- Defined in modules/util/Listenable.ts:54

addListener

addListener(eventName: string, listener: EventListener): EventEmitter
Adds new listener.
Parameters
- eventName: string
  the name of the event
- listener: EventListener
  the listener.
Returns EventEmitter
- The emitter, so that calls can be chained.
Inherited from Listenable.addListener
- Defined in modules/util/Listenable.ts:85

createNonAnonymousRoom

createNonAnonymousRoom(): void
Returns void
- Defined in modules/xmpp/ChatRoom.ts:668

dial

dial(number: string): Promise<void>
Dials a number.
Parameters
- number: string
  the number
Returns Promise<void>
- Defined in modules/xmpp/ChatRoom.ts:2028

discoRoomInfo

discoRoomInfo(): void
Returns void
- Defined in modules/xmpp/ChatRoom.ts:566

doLeave

doLeave(reason?: string): void
Sends the presence unavailable, signaling the server we want to leave the room.
Parameters
- Optionalreason: string
Returns void
- Defined in modules/xmpp/ChatRoom.ts:532

emit

emit(event: string, ...args: any[]): void
Emits an event.
Parameters
- event: string
  event name
- ...args: any[]
Returns void
Inherited from Listenable.emit
- Defined in modules/util/Listenable.ts:104

end

end(): void
Ends the conference for all participants.

Returns void
- Defined in modules/xmpp/ChatRoom.ts:2262

getAVModeration

getAVModeration(): AVModeration
Returns AVModeration
- Defined in modules/xmpp/ChatRoom.ts:2052

getBreakoutRooms

getBreakoutRooms(): BreakoutRooms
Returns BreakoutRooms
- Defined in modules/xmpp/ChatRoom.ts:2059

getFileSharing

getFileSharing(): FileSharing
Returns FileSharing
- Defined in modules/xmpp/ChatRoom.ts:2066

getLobby

getLobby(): Lobby
Returns Lobby
- Defined in modules/xmpp/ChatRoom.ts:2045

getMediaPresenceInfo

getMediaPresenceInfo(endpointId: string, mediaType: MediaType): IPeerMediaInfo
Obtains the info about given media advertised (in legacy format) in the MUC presence of the participant identified by the given endpoint JID. This is for mantining interop with endpoints that do not support source-name signaling (Jigasi and very old mobile clients).
Parameters
- endpointId: string
  the endpoint ID mapped to the participant which corresponds to MUC nickname.
- mediaType: MediaType
  the type of the media for which presence info will be obtained.
Returns IPeerMediaInfo
presenceInfo an object with media presence info or null either if there is no presence available or if the media type given is invalid.
- Defined in modules/xmpp/ChatRoom.ts:1962

getMeetingId

getMeetingId(): string
Returns the meeting unique ID if any came from backend.

Returns string
- The meeting ID.
- Defined in modules/xmpp/ChatRoom.ts:2096

getMemberRole

getMemberRole(peerJid: string): string
Parameters
- peerJid: string
Returns string
- Defined in modules/xmpp/ChatRoom.ts:2006

getMetadataHandler

getMetadataHandler(): RoomMetadata
Returns RoomMetadata
- Defined in modules/xmpp/ChatRoom.ts:2073

getPhoneNumber

getPhoneNumber(): string
Returns the phone number for joining the conference.

Returns string
- Defined in modules/xmpp/ChatRoom.ts:2080

getPhonePin

getPhonePin(): string
Returns the pin for joining the conference with phone.

Returns string
- Defined in modules/xmpp/ChatRoom.ts:2087

getShortTermCredentials

getShortTermCredentials(service: string): Promise<string>
Requests short-lived credentials for a service. The function does not use anything from the room, but the backend requires the sender to be in the room as the credentials contain the meeting ID and are valid only for the room.
Parameters
- service: string
Returns Promise<string>
- Defined in modules/xmpp/ChatRoom.ts:2283

hangup

hangup(): Promise<void>
Hangup an existing call

Returns Promise<void>
- Defined in modules/xmpp/ChatRoom.ts:2037

isFocus

isFocus(mucJid: string): boolean
Checks if the user identified by given mucJid is the conference focus.
Parameters
- mucJid: string
  the full MUC address of the user to be checked.
Returns boolean
true if MUC user is the conference focus or false if is not. When given mucJid does not exist in the MUC then null is returned.
- Defined in modules/xmpp/ChatRoom.ts:1935

isModerator

isModerator(): boolean
Returns boolean
- Defined in modules/xmpp/ChatRoom.ts:1948

join

join(password?: string, replaceParticipant?: boolean): Promise<void>
Joins the chat room.
Parameters
- Optionalpassword: string
  Password to unlock room on joining.
- OptionalreplaceParticipant: boolean
Returns Promise<void>
- resolved when join completes. At the time of this writing it's never rejected.
- Defined in modules/xmpp/ChatRoom.ts:446

kick

kick(jid: string, reason?: string): void
Parameters
- jid: string
- reason: string = 'You have been kicked.'
Returns void
- Defined in modules/xmpp/ChatRoom.ts:1648

leave

leave(reason?: string): Promise<any>
Leaves the room. Closes the jingle session.
Parameters
- Optionalreason: string
Returns Promise<any>
which is resolved if XMPPEvents.MUC_LEFT is received less than 5s after sending presence unavailable. Otherwise the promise is rejected.
- Defined in modules/xmpp/ChatRoom.ts:2211

listenerCount

listenerCount(eventName?: string): number
Returns the number of listeners for the specified event.
Parameters
- OptionaleventName: string
  The name of the event.
Returns number
- The number of listeners for the event.
Inherited from Listenable.listenerCount
- Defined in modules/util/Listenable.ts:120

lockRoom

lockRoom(
    key: string,
    onSuccess: SuccessCallback,
    onError: ErrorCallback,
    onNotSupported: () => void,
): void
Parameters
- key: string
- onSuccess: SuccessCallback
- onError: ErrorCallback
- onNotSupported: () => void
Returns void
- Defined in modules/xmpp/ChatRoom.ts:1671

muteParticipant

muteParticipant(jid: string, mute: boolean, mediaType: string): void
Mutes remote participant.
Parameters
- jid: string
  of the participant
- mute: boolean
- mediaType: string
Returns void
- Defined in modules/xmpp/ChatRoom.ts:2106

off

off(eventId: string, handler?: EventListener): void
Removes event listener.
Parameters
- eventId: string
  The event ID.
- Optionalhandler: EventListener
  Optional, the specific handler to unbind.
Returns void
Inherited from Listenable.off
- Defined in modules/util/Listenable.ts:36

on

on(eventId: string, handler: EventListener): void
Attaches a handler for events (e.g., "participant joined") in the conference. All possible events are defined in JitsiConferenceEvents.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
Inherited from Listenable.on
- Defined in modules/util/Listenable.ts:27

once

once(eventId: string, handler: EventListener): void
Adds a one-time listener function for the event.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
Inherited from Listenable.once
- Defined in modules/util/Listenable.ts:45

removeAllListeners

removeAllListeners(): void
Removes all listeners for the event emitter.

Returns void
Inherited from Listenable.removeAllListeners
- Defined in modules/util/Listenable.ts:111

removeEventListener

removeEventListener(eventId: string, handler?: EventListener): void
Alias for off method.
Parameters
- eventId: string
  The event ID.
- Optionalhandler: EventListener
  Optional, the specific handler to unbind.
Returns void
Inherited from Listenable.removeEventListener
- Defined in modules/util/Listenable.ts:63

removeListener

removeListener(eventName: string, listener: EventListener): EventEmitter
Removes listener.
Parameters
- eventName: string
  the name of the event that triggers the listener
- listener: EventListener
  the listener.
Returns EventEmitter
- The emitter, so that calls can be chained.
Inherited from Listenable.removeListener
- Defined in modules/util/Listenable.ts:96

sendMessage

sendMessage(message: string, elementName: string, replyToId?: string): void
Send text message to the other participants in the conference
Parameters
- message: string
- elementName: string
- OptionalreplyToId: string
Returns void
- Defined in modules/xmpp/ChatRoom.ts:1116

sendPresence

sendPresence(fromJoin?: boolean): void
Parameters
- fromJoin: boolean = false
  Whether this is initial presence to join the room.
Returns void
- Defined in modules/xmpp/ChatRoom.ts:479

sendPrivateMessage

sendPrivateMessage(
    id: string,
    message: string,
    elementName: string,
    useDirectJid?: boolean,
    replyToId?: string,
): void
Send private text message to another participant of the conference
Parameters
- id: string
  id/muc resource of the receiver
- message: string
- elementName: string
- useDirectJid: boolean = false
- OptionalreplyToId: string
Returns void
- Defined in modules/xmpp/ChatRoom.ts:1174

sendReaction

sendReaction(reaction: string, messageId: string, receiverId?: string): void
Sends a reaction message to the other participants in the conference.
Parameters
- reaction: string
  The reaction being sent.
- messageId: string
  The id of the message being sent.
- OptionalreceiverId: string
  The receiver of the message if it is private.
Returns void
- Defined in modules/xmpp/ChatRoom.ts:1145

setAffiliation

setAffiliation(jid: string, affiliation: string): void
Parameters
- jid: string
- affiliation: string
Returns void
- Defined in modules/xmpp/ChatRoom.ts:1624

setMeetingId

setMeetingId(meetingId: string): void
Sets the meeting unique Id (received from the backend).
Parameters
- meetingId: string
  The new meetings id.
Returns void
- Defined in modules/xmpp/ChatRoom.ts:655

setMembersOnly

setMembersOnly(
    enabled: boolean,
    onSuccess: SuccessCallback,
    onError: ErrorCallback,
): void
Turns off or on the members only config for the main room.
Parameters
- enabled: boolean
  Whether to turn it on or off.
- onSuccess: SuccessCallback
  optional callback.
- onError: ErrorCallback
  optional callback.
Returns void
- Defined in modules/xmpp/ChatRoom.ts:1763

setParticipantPropertyListener

setParticipantPropertyListener(listener: ParticipantPropertyListener): void
Sets the special listener to be used for "command"s whose name starts with "jitsi_participant_".
Parameters
- listener: ParticipantPropertyListener
Returns void
- Defined in modules/xmpp/ChatRoom.ts:1106

setSubject

setSubject(subject: string): void
Parameters
- subject: string
Returns void
- Defined in modules/xmpp/ChatRoom.ts:1203

Class ChatRoom

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

disableFocus

disableDiscoInfo

enableLobby

hiddenFromRecorderFeatureEnabled

Returns ChatRoom

Properties

connection

connectionTimes

focusMucJid

joined

OptionalmembersOnlyEnabled

myroomjid

presMap

role

roomjid

transcriptionStatus

OptionalvisitorsSupported

xmpp

Methods

addCancellableListener

Parameters

Returns () => void

addEventListener

Parameters

Returns void

addListener

Parameters

Returns EventEmitter

createNonAnonymousRoom

Returns void

dial

Parameters

Returns Promise<void>

discoRoomInfo

Returns void

doLeave

Parameters

Returns void

emit

Parameters

Returns void

end

Returns void

getAVModeration

Returns AVModeration

getBreakoutRooms

Returns BreakoutRooms

getFileSharing

Returns FileSharing

getLobby

Returns Lobby

getMediaPresenceInfo

Parameters

Returns IPeerMediaInfo

getMeetingId

Returns string

getMemberRole

Parameters

Returns string

getMetadataHandler

Returns RoomMetadata

getPhoneNumber

Returns string

getPhonePin

Returns string

getShortTermCredentials

Parameters

Returns Promise<string>

hangup

Returns Promise<void>

isFocus

`Optional`membersOnlyEnabled

`Optional`visitorsSupported