RoomStore class abstract

Room management related interfaces, managing room creation, joining, leaving, scheduling and other operations.

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

Note: 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

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

Constructors

RoomStore()

Properties

hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state → RoomState: Room related state data provided by RoomStore
no setter

Methods

acceptCall(String roomID) → Future<CompletionHandler>: Accept call
addRoomListener(RoomListener listener) → void: Add room event callback listener
addScheduledAttendees({required String roomID, required List<String> userIDList}) → Future<CompletionHandler>: Add scheduled attendees
callUserToRoom({required String roomID, required List<String> userIDList, int timeout = 0, String? extensionInfo}) → Future<CallUserToRoomCompletionHandler>: Call user to join room
cancelCall({required String roomID, required List<String> userIDList}) → Future<CompletionHandler>: Cancel call
cancelScheduledRoom(String roomID) → Future<CompletionHandler>: Cancel scheduled room
createAndJoinRoom({required String roomID, required RoomType roomType, required CreateRoomOptions options}) → Future<CompletionHandler>: Create and join room
endRoom() → Future<CompletionHandler>: End room
getPendingCalls({required String roomID, required String? cursor}) → Future<ListResultCompletionHandler<RoomCall>>: Get pending calls list
getRoomInfo(String roomID) → Future<GetRoomInfoCompletionHandler>: Get room info
getScheduledAttendees({required String roomID, required String? cursor}) → Future<ListResultCompletionHandler<RoomUser>>: Get scheduled room attendees
getScheduledRoomList(String? cursor) → Future<ListResultCompletionHandler<RoomInfo>>: Get scheduled room list
joinRoom({required String roomID, required RoomType roomType, String? password = ""}) → Future<CompletionHandler>: Join room
leaveRoom() → Future<CompletionHandler>: Leave room
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
rejectCall({required String roomID, required CallRejectionReason reason}) → Future<CompletionHandler>: Reject call
removeRoomListener(RoomListener listener) → void: Remove room event callback listener
removeScheduledAttendees({required String roomID, required List<String> userIDList}) → Future<CompletionHandler>: Remove scheduled attendees
reset() → void: Reset room state
scheduleRoom({required String roomID, required ScheduleRoomOptions options}) → Future<CompletionHandler>: Schedule a room
toString() → String: A string representation of this object.
inherited
updateRoomInfo({required String roomID, required UpdateRoomOptions options, required List<UpdateRoomOptionsModifyFlag> modifyFlagList}) → Future<CompletionHandler>: Update room info
updateScheduledRoom({required String roomID, required ScheduleRoomOptions options, required List<ScheduleRoomOptionsModifyFlag> modifyFlagList}) → Future<CompletionHandler>: Update scheduled room

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

shared → RoomStore: Singleton object
no setter