ChatRoom class
The chat room instance class.
Note To get the correct value, ensure that you call ChatRoomManager.fetchChatRoomInfoFromServer before calling this method.
Constructors
-
ChatRoom.new({required String roomId, String? name, String? description, String? owner, String? announcement, int? memberCount, int? maxUsers, List<
String> ? adminList, List<String> ? memberList, List<String> ? blockList, List<String> ? muteList, bool? isAllMemberMuted, ChatRoomPermissionType permissionType = ChatRoomPermissionType.None, bool isInWhitelist = false, int createTimestamp = 0, int muteExpireTimestamp = 0}) -
ChatRoom.fromJson(Map<
String, dynamic> map) -
factory
Properties
-
adminList
→ List<
String> ? -
Gets the chat room admin list.
final
- announcement → String?
-
Gets the chat room announcement in the chat room from the memory.
final
-
blockList
→ List<
String> ? -
Gets the chat room block list.
final
- createTimestamp → int
-
Gets the timestamp(ms) when the chat room was created.
This property is available once join the chat room.
final
- description → String?
-
Gets the chat room description from the memory.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isAllMemberMuted → bool?
-
Checks whether all members are muted,This property is available once join the chat room.
After joining the chat room, when you receive a callback for muting or unmuting all members, this property will be updated.
final
- isInWhitelist → bool
-
Current user is in allow list or not.
This property is available once join the chat room.
This property will be updated when current user is added or removed from the white list.
final
- maxUsers → int?
-
Gets the maximum number of members in the chat room from the memory, which is set/specified when the chat room is created.
final
- memberCount → int?
-
This includes the chat room owner, administrators, and regular members.
You can get this information after joining the chat room.
This property is updated when members join or leave the chat room.
final
-
memberList
→ List<
String> ? -
Gets the member list.
final
- muteExpireTimestamp → int
-
Gets the timestamp(ms) when Current user will be unmuted.
final
-
muteList
→ List<
String> ? -
Gets the mute list of the chat room.
final
- name → String?
-
Gets the chat room name from the memory.
final
- owner → String?
-
Gets the chat room owner ID. If this method returns an empty string, the SDK fails to get chat room details.
final
- permissionType → ChatRoomPermissionType
-
Gets the current user's role in the chat room. The role types: ChatRoomPermissionType.
final
- roomId → String
-
Gets the chat room ID.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited