RoomParticipantStore class abstract
Room participant management related interfaces, managing participant permissions, device control, message muting and other operations.
RoomParticipantStore Manage participant permissions, device control, message muting and other operations in the room.
Room participant management provides complete participant lifecycle management, including permission management, device control, message muting and other features. RoomParticipantStore provides a comprehensive set of APIs to manage room participant related operations.
Key Features
- Permission Management：Supports transferring owner, setting/revoking admin, kicking users and other operations
- Device Control：Supports closing participant devices, disabling all devices and other operations
- Message Muting：Supports muting individual users or all users
- Device Request/Invitation：Supports requesting to open device, inviting to open device and other bidirectional interactions
Note: Participant status updates are delivered through state publisher. Subscribe to it to receive real-time updates about participant list.
Topics
Creating Instance
- create : Create object instance
Observing State and Events
- state : Reactive state containing participant list and device request info
- addRoomParticipantListener/removeRoomParticipantListener : Participant event callback
Participant List
- getParticipantList : Get participant list
Permission Management
- transferOwner : Transfer owner
- setAdmin : Set admin
- revokeAdmin : Revoke admin
- kickUser : Kick user
- updateParticipantNameCard : Update participant name card
- updateParticipantMetaData : Update participant metadata
Local Microphone Control
- muteMicrophone : Mute microphone
- unmuteMicrophone : Unmute microphone
Device Control
- closeParticipantDevice : Close participant device
- disableUserMessage : Mute user
- disableAllDevices : Disable all devices
- disableAllMessages : Mute all users
Device Request Operations
- requestToOpenDevice : Request to open device
- cancelOpenDeviceRequest : Cancel open device request
- approveOpenDeviceRequest : Approve open device request
- rejectOpenDeviceRequest : Reject open device request
Device Invitation Operations
- inviteToOpenDevice : Invite to open device
- cancelOpenDeviceInvitation : Cancel open device invitation
- acceptOpenDeviceInvitation : Accept open device invitation
- declineOpenDeviceInvitation : Decline open device invitation
See Also
Constructors
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 → RoomParticipantState
-
Participant related state data provided by RoomParticipantStore
no setter
Methods
-
acceptOpenDeviceInvitation(
{required String userID, required DeviceType device}) → Future< CompletionHandler> - Accept open device invitation
-
addRoomParticipantListener(
RoomParticipantListener listener) → void - Add participant event callback listener
-
approveOpenDeviceRequest(
{required DeviceType device, required String userID}) → Future< CompletionHandler> - Approve open device request
-
cancelOpenDeviceInvitation(
{required String userID, required DeviceType device}) → Future< CompletionHandler> - Cancel open device invitation
-
cancelOpenDeviceRequest(
DeviceType device) → Future< CompletionHandler> - Cancel open device request
-
closeParticipantDevice(
{required String userID, required DeviceType device}) → Future< CompletionHandler> - Close participant device
-
declineOpenDeviceInvitation(
{required String userID, required DeviceType device}) → Future< CompletionHandler> - Decline open device invitation
-
disableAllDevices(
{required DeviceType device, required bool disable}) → Future< CompletionHandler> - Disable all devices
-
disableAllMessages(
bool disable) → Future< CompletionHandler> - Mute all users
-
disableUserMessage(
{required String userID, required bool disable}) → Future< CompletionHandler> - Mute user
-
getParticipantList(
String? cursor) → Future< ListResultCompletionHandler< RoomParticipant> > - Get participant list
-
inviteToOpenDevice(
{required String userID, required DeviceType device, int timeout = 0}) → Future< CompletionHandler> - Invite to open device
-
kickUser(
String userID) → Future< CompletionHandler> - Kick user
-
muteMicrophone(
) → void - Mute microphone
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rejectOpenDeviceRequest(
{required DeviceType device, required String userID}) → Future< CompletionHandler> - Reject open device request
-
removeRoomParticipantListener(
RoomParticipantListener listener) → void - Remove participant event callback listener
-
requestToOpenDevice(
{required DeviceType device, int timeout = 0}) → Future< CompletionHandler> - Request to open device
-
revokeAdmin(
String userID) → Future< CompletionHandler> - Revoke admin
-
setAdmin(
String userID) → Future< CompletionHandler> - Set admin
-
toString(
) → String -
A string representation of this object.
inherited
-
transferOwner(
String userID) → Future< CompletionHandler> - Transfer owner
-
unmuteMicrophone(
) → Future< CompletionHandler> - Unmute microphone
-
updateParticipantMetaData(
{required String userID, required Map< String, String> metaData}) → Future<CompletionHandler> - Update participant metadata
-
updateParticipantNameCard(
{required String userID, required String nameCard}) → Future< CompletionHandler> - Update participant name card
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
String roomID) → RoomParticipantStore - Create RoomParticipantStore instance