ChatroomService class Null safety

Constructors

ChatroomService()
factory

Properties

hashCode int
The hash code for this object.
read-only, inherited
independentModeLinkAddressProvider ↔ NIMChatroomIndependentModeLinkAddressProvider?
Get the provider of the link for entering the chatroom in the independent mode, which refers to the case when the user enters a chatroom without logging into IM first. The field is required for the independent mode. If it is not configured, the chatroom will be inaccessible.
read / write
onEventNotified Stream<NIMChatroomEvent>
The chatroom event stream
read-only
onMessageAttachmentProgressUpdate Stream<NIMAttachmentProgress>
Listen to the progress of the upload/download of the attachments of chatroom messages. The notification's key is NIMMessage.uuid.
read-only
onMessageReceived Stream<List<NIMChatroomMessage>>
Listen to the receiving of chatroom messages.
read-only
onMessageStatusChanged Stream<NIMChatroomMessage>
Listen to the status changes of chatroom messages.
read-only
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

batchUpdateChatroomQueue({required String roomId, required List<NIMChatroomQueueEntry> entryList, bool needNotify = true, Map<String, dynamic>? notifyExtension}) Future<NIMResult<List<String>>>
Update multiple elements of the chatroom queue.
clearChatroomQueue(String roomId) Future<NIMResult<void>>
Clear the elements of the queue.
downloadAttachment(NIMChatroomMessage message, [bool thumb = false]) Future<NIMResult<void>>
Download the attachment of the chatroom message.
enterChatroom(NIMChatroomEnterRequest request) Future<NIMResult<NIMChatroomEnterResult>>
Join the chatroom
exitChatroom(String roomId) Future<NIMResult<void>>
Exit the chatroom
fetchChatroomInfo(String roomId) Future<NIMResult<NIMChatroomInfo>>
Get the information of the current chatroom.
fetchChatroomMembers({required String roomId, required NIMChatroomMemberQueryType queryType, required int limit, String? lastMemberAccount}) Future<NIMResult<List<NIMChatroomMember>>>
Get the current chat room members.
fetchChatroomMembersByAccount({required String roomId, required List<String> accountList}) Future<NIMResult<List<NIMChatroomMember>>>
Get the current chatroom members.
fetchChatroomQueue(String roomId) Future<NIMResult<List<NIMChatroomQueueEntry>>>
Get the chatroom queue.
fetchMessageHistory({required String roomId, required int startTime, required int limit, required QueryDirection direction, List<NIMMessageType>? messageTypeList}) Future<NIMResult<List<NIMChatroomMessage>>>
Get history messages. You can specify a period to query history messages and list the results in reverse-chronological order or chronological order. The obtained history messages contain chatroom notifications.
kickChatroomMember(NIMChatroomMemberOptions options) Future<NIMResult<void>>
Remove a member from the chatroom.
markChatroomMemberBeManager({required bool isAdd, required NIMChatroomMemberOptions options}) Future<NIMResult<NIMChatroomMember>>
Assign the admin role to a member or unassign the admin role from a member.
markChatroomMemberBeNormal({required bool isAdd, required NIMChatroomMemberOptions options}) Future<NIMResult<NIMChatroomMember>>
Assign the normal member role to a member or unassign the role from a member.
markChatroomMemberInBlackList({required bool isAdd, required NIMChatroomMemberOptions options}) Future<NIMResult<NIMChatroomMember>>
Add a member to the blocklist or remove a member from it.
markChatroomMemberMuted({required bool isAdd, required NIMChatroomMemberOptions options}) Future<NIMResult<NIMChatroomMember>>
Add a member to the mute list or remove a member from it.
markChatroomMemberTempMuted({required int duration, required NIMChatroomMemberOptions options, bool needNotify = false}) Future<NIMResult<void>>
Add a member to the temporary mute list or remove a member from it.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
pollChatroomQueueEntry(String roomId, String? key) Future<NIMResult<NIMChatroomQueueEntry>>
Remove an element from the queue.
sendChatroomAudioMessage({required String roomId, required String filePath, required int duration, NIMNosScene nosScene = NIMNosScenes.defaultIm, bool resend = false, ChatroomMessageAction? action}) Future<NIMResult<NIMChatroomMessage>>
Send an audio message in the chatroom.
sendChatroomCustomMessage({required String roomId, NIMMessageAttachment? attachment, bool resend = false, ChatroomMessageAction? action}) Future<NIMResult<NIMChatroomMessage>>
Send a custom message in the chatroom.
sendChatroomFileMessage({required String roomId, required String filePath, required String displayName, NIMNosScene nosScene = NIMNosScenes.defaultIm, bool resend = false, ChatroomMessageAction? action}) Future<NIMResult<NIMChatroomMessage>>
Send a file message in the chatroom.
sendChatroomImageMessage({required String roomId, required String filePath, String? displayName, NIMNosScene nosScene = NIMNosScenes.defaultIm, bool resend = false, ChatroomMessageAction? action}) Future<NIMResult<NIMChatroomMessage>>
Send an image message in the chatroom.
sendChatroomLocationMessage({required String roomId, required double latitude, required double longitude, required String address, bool resend = false, ChatroomMessageAction? action}) Future<NIMResult<NIMChatroomMessage>>
Send a location message in the chatroom.
sendChatroomMessage(NIMChatroomMessage message, [bool resend = false]) Future<NIMResult<NIMChatroomMessage>>
Send a message in the chatroom
sendChatroomRobotMessage({required String roomId, required String robotAccount, required NIMRobotMessageType type, String? text, String? content, String? target, String? params, bool resend = false, ChatroomMessageAction? action}) Future<NIMResult<NIMChatroomMessage>>
Send a robot message in the chatroom.
sendChatroomTextMessage({required String roomId, required String text, bool resend = false, ChatroomMessageAction? action}) Future<NIMResult<NIMChatroomMessage>>
Send a text message in the chatroom.
sendChatroomTipMessage({required String roomId, bool resend = false, ChatroomMessageAction? action}) Future<NIMResult<NIMChatroomMessage>>
Send a tip message in the chatroom.
sendChatroomVideoMessage({required String roomId, required String filePath, required int duration, required int width, required int height, String? displayName, NIMNosScene nosScene = NIMNosScenes.defaultIm, bool resend = false, ChatroomMessageAction? action}) Future<NIMResult<NIMChatroomMessage>>
Send a video message in the chatroom.
toString() String
A string representation of this object.
inherited
updateChatroomInfo({required String roomId, required NIMChatroomUpdateRequest request, bool needNotify = true, Map<String, Object>? notifyExtension}) Future<NIMResult<void>>
Edit the chatroom information. Only the chatroom creator and admins have permission to perform the operation. You can determine whether to trigger a notification (notification type: NIMChatroomNotificationTypes.chatRoomInfoUpdated ) when the chatroom information is modified.
updateChatroomMyMemberInfo({required String roomId, required NIMChatroomUpdateMyMemberInfoRequest request, bool needNotify = true, Map<String, dynamic>? notifyExtension}) Future<NIMResult<void>>
Update the current user's information in the chatroom.
updateChatroomQueueEntry({required String roomId, required NIMChatroomQueueEntry entry, bool isTransient = false}) Future<NIMResult<void>>
Update an element of the chatroom queue.

Operators

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