EMChatRoomManager class

~english The chat room manager class, which manages user joining and exiting the chat room, retrieving the chat room list, and managing member privileges. The sample code for joining a chat room:

  try {
      await EMClient.getInstance.chatRoomManager.joinChatRoom(chatRoomId);
  } on EMError catch (e) {
      debugPrint(e.toString());
  }

~end

~chinese 聊天室管理类，负责聊天室加入和退出、聊天室列表获取以及成员权限管理等。 比如，加入聊天室：

  try {
      await EMClient.getInstance.chatRoomManager.joinChatRoom(chatRoomId);
  } on EMError catch (e) {
      debugPrint(e.toString());
  }

~end

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addAttributes(String roomId, {required Map<String, String> attributes, bool deleteWhenLeft = false, bool overwrite = false}) → Future<Map<String, int>?>

~english Sets custom chat room attributes.

addChatRoomAdmin(String roomId, String admin) → Future<void>

~english Adds a chat room admin.

addEventHandler(String identifier, EMChatRoomEventHandler handler) → void

~english Adds the room event handler. After calling this method, you can handle for new room event when they arrive.

addMembersToChatRoomAllowList(String roomId, List<String> members) → Future<void>

~english Adds members to the allowlist.

blockChatRoomMembers(String roomId, List<String> members) → Future<void>

~english Adds the specified members to the block list of the chat room.

changeChatRoomDescription(String roomId, String description) → Future<void>

~english Modifies the chat room description.

changeChatRoomName(String roomId, String name) → Future<void>

~english Changes the chat room name.

changeOwner(String roomId, String newOwner) → Future<void>

~english Transfers the chat room ownership.

clearEventHandlers() → void

~english Clear all room event handlers. ~end

createChatRoom(String name, {String? desc, String? welcomeMsg, int maxUserCount = 300, List<String>? members}) → Future<EMChatRoom>

~english Creates a chat room.

destroyChatRoom(String roomId) → Future<void>

~english Destroys a chat room.

fetchChatRoomAllowListFromServer(String roomId) → Future<List<String>>

~english Gets the allow list from the server.

fetchChatRoomAnnouncement(String roomId) → Future<String?>

~english Gets the chat room announcement from the server.

fetchChatRoomAttributes({required String roomId, List<String>? keys}) → Future<Map<String, String>?>

~english Gets the list of custom chat room attributes based on the attribute key list.

fetchChatRoomBlockList(String roomId, {int pageNum = 1, int pageSize = 200}) → Future<List<String>>

~english Gets the chat room block list with pagination.

fetchChatRoomInfoFromServer(String roomId, {bool fetchMembers = false}) → Future<EMChatRoom>

~english Gets the details of the chat room from the server. By default, the details do not include the chat room member list.

fetchChatRoomMembers(String roomId, {String? cursor, int pageSize = 200}) → Future<EMCursorResult<String>>

~english Gets the chat room member list.

fetchChatRoomMuteList(String roomId, {int pageNum = 1, int pageSize = 200}) → Future<List<String>>

~english Gets the list of members who are muted in the chat room from the server.

fetchPublicChatRoomsFromServer({int pageNum = 1, int pageSize = 200}) → Future<EMPageResult<EMChatRoom>>

~english Gets chat room data from the server with pagination.

getChatRoomWithId(String roomId) → Future<EMChatRoom?>

~english Gets the chat room in the cache.

getEventHandler(String identifier) → EMChatRoomEventHandler?

~english Get the room event handler.

isMemberInChatRoomAllowList(String roomId) → Future<bool>

~english Checks whether the member is on the allow list.

joinChatRoom(String roomId) → Future<void>

~english Joins the chat room.

leaveChatRoom(String roomId) → Future<void>

~english Leaves the chat room.

muteAllChatRoomMembers(String roomId) → Future<void>

~english Mutes all members.

muteChatRoomMembers(String roomId, List<String> muteMembers, {int duration = -1}) → Future<void>

~english Mutes the specified members in a chat room.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeAttributes(String roomId, {required List<String> keys, bool force = false}) → Future<Map<String, int>?>

~english Removes custom chat room attributes.

removeChatRoomAdmin(String roomId, String admin) → Future<void>

~english Removes privileges of a chat room admin.

removeChatRoomMembers(String roomId, List<String> members) → Future<void>

~english Removes the specified members from a chat room.

removeEventHandler(String identifier) → void

~english Remove the room event handler.

removeMembersFromChatRoomAllowList(String roomId, List<String> members) → Future<void>

~english Removes members from the allow list.

toString() → String

A string representation of this object.

inherited

unBlockChatRoomMembers(String roomId, List<String> members) → Future<void>

~english Removes the specified members from the block list of the chat room.

unMuteAllChatRoomMembers(String roomId) → Future<void>

~english Unmutes all members.

unMuteChatRoomMembers(String roomId, List<String> unMuteMembers) → Future<void>

~english Unmutes the specified members in a chat room.

updateChatRoomAnnouncement(String roomId, String announcement) → Future<void>

~english Updates the chat room announcement.

Operators

operator ==(Object other) → bool

The equality operator.

inherited