Room Store
Room management related interfaces, managing room creation, joining, leaving, scheduling and other operations.
Overview
RoomStore Manage room creation, joining, leaving, scheduling and other operations. Room management provides complete room lifecycle management, including instant rooms and scheduled rooms. RoomStore provides a comprehensive set of APIs to manage room-related operations.
Key Features
Instant Room:Supports creating and joining instant rooms
Scheduled Room:Supports scheduling rooms, modifying schedules, canceling schedules and other operations
Room Call:Supports calling users to join rooms, accepting/rejecting calls and other operations
State Management:Real-time tracking of current room status and scheduled room list
Tip: Room status updates are delivered through state publisher. Subscribe to it to receive real-time updates about current room and scheduled room list.
Topics
Getting Instance
RoomStore.shared - Get singleton object
Observing State and Events
state - Reactive state containing current room and scheduled room list
addRoomListener/removeRoomListener - Room event callback
Scheduled Room Operations
getScheduledRoomList - Get scheduled room list
getScheduledAttendees - Get scheduled room attendees
scheduleRoom - Schedule a room
updateScheduledRoom - Update scheduled room
addScheduledAttendees - Add scheduled attendees
removeScheduledAttendees - Remove scheduled attendees
cancelScheduledRoom - Cancel scheduled room
Instant Room Operations
createAndJoinRoom - Create and join room
joinRoom - Join room
leaveRoom - Leave room
endRoom - End room
updateRoomInfo - Update room info
getRoomInfo - Get room info
Room Call Operations
getPendingCalls - Get pending calls list
callUserToRoom - Call user to join room
cancelCall - Cancel call
acceptCall - Accept call
rejectCall - Reject call
See Also
Properties
Functions
Accept call
Add room event callback listener
Add scheduled attendees
Call user to join room
Cancel call
Cancel scheduled room
Create and join room
End room
Get pending calls list
Get room info
Get scheduled room attendees
Get scheduled room list
Join room
Leave room
Reject call
Remove room event callback listener
Remove scheduled attendees
Schedule a room
Update room info
Update scheduled room