ChatUIKit class

Inheritance
Mixed-in types

Constructors

ChatUIKit()

Properties

currentUserId String?
Get current user id
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
observers List<ChatUIKitObserverBase>
finalinherited
options Options?
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

acceptContactRequest({required String userId}) Future<void>
inherited
acceptGroupInvitation({required String groupId, required String userId}) Future<Group>
inherited
acceptGroupJoinApplication({required String groupId, required String userId}) Future<void>
inherited
addAttributes({required String roomId, required Map<String, String> attributes, bool deleteWhenLeft = false, bool overwrite = false}) Future<Map<String, int>?>
inherited
addBlockedContact({required String userId}) Future<void>
inherited
addChatRoomAdmin({required String roomId, required String admin}) Future<void>
inherited
addGroupAdmin({required String groupId, required String memberId}) Future<void>
inherited
addGroupAllowMembers({required String groupId, required List<String> members}) Future<void>
inherited
addGroupBlockList({required String groupId, required List<String> members}) Future<void>
inherited
addGroupMembers({required String groupId, required List<String> members, String? welcome}) Future<void>
inherited
addGroupMuteMembers({required String groupId, required List<String> members, int duration = -1}) Future<void>
inherited
addListeners() → void
inherited
addMembersToChatRoomAllowList({required String roomId, required List<String> members}) Future<void>
inherited
addObserver(ChatUIKitObserverBase observer) → void
inherited
addReaction({required String messageId, required String reaction}) Future<void>
inherited
appointNewMessageConversationCount({required List<String> appointIds}) Future<int>
inherited
bindDeviceToken({required String notifierName, required String deviceToken}) Future<void>
inherited
blockChatRoomMembers({required String roomId, required List<String> members}) Future<void>
inherited
blockGroup({required String groupId}) Future<void>
inherited
changeChatRoomDescription({required String roomId, required String description}) Future<void>
inherited
changeChatRoomName({required String roomId, required String name}) Future<void>
inherited
changeGroupDescription({required String groupId, required String desc}) Future<void>
inherited
changeGroupName({required String groupId, required String name}) Future<void>
inherited
changeGroupOwner({required String groupId, required String newOwner}) Future<void>
inherited
changeOwner({required String roomId, required String newOwner}) Future<void>
inherited
checkResult<T>(ChatSDKEvent actionEvent, Future<T> method()) Future<T>
inherited
clearSilentMode({required String conversationId, required ConversationType type}) Future<void>
inherited
clearUserInfoCache() → void
inherited
connectHandler({VoidCallback? onConnected, VoidCallback? onDisconnected, dynamic onUserDidLoginFromOtherDevice(LoginExtensionInfo)?, VoidCallback? onUserDidRemoveFromServer, VoidCallback? onUserDidForbidByServer, VoidCallback? onUserDidChangePassword, VoidCallback? onUserDidLoginTooManyDevice, VoidCallback? onUserKickedByOtherDevice, VoidCallback? onUserAuthenticationFailed, VoidCallback? onTokenWillExpire, VoidCallback? onTokenDidExpire, VoidCallback? onAppActiveNumberReachLimit}) → void
inherited
contactRequestCount() int
inherited
createChatRoom({required String name, String? desc, String? welcomeMsg, int maxUserCount = 300, List<String>? members}) Future<ChatRoom>
inherited
createChatThread({required String threadName, required String messageId, required String parentId}) Future<ChatThread>
inherited
createConversation({required String conversationId, ConversationType type = ConversationType.Chat}) Future<Conversation>
inherited
createGroup({required String groupName, String? desc, List<String>? inviteMembers, String? inviteReason, required GroupOptions options}) Future<Group>
inherited
declineContactRequest({required String userId}) Future<void>
inherited
declineGroupInvitation({required String groupId, required String inviter, String? reason}) Future<void>
inherited
declineGroupJoinApplication({required String groupId, required String userId, String? reason}) Future<void>
inherited
deleteBlockedContact({required String userId}) Future<void>
inherited
deleteContact({required String userId}) Future<void>
inherited
deleteGroupAdmin({required String groupId, required String memberId}) Future<void>
inherited
deleteGroupAllowMembers({required String groupId, required List<String> members}) Future<void>
inherited
deleteGroupBlockList({required String groupId, required List<String> members}) Future<void>
inherited
deleteGroupMemberAttributes({required String groupId, required List<String> keys, String? userId}) Future<void>
inherited
deleteGroupMembers({required String groupId, required List<String> members}) Future<void>
inherited
deleteGroupMuteMembers({required String groupId, required List<String> members}) Future<void>
inherited
deleteLocalConversation({required String conversationId, bool deleteMessages = true}) Future<void>
inherited
deleteLocalMessageById({required String conversationId, required ConversationType type, required String messageId}) Future<void>
inherited
deleteLocalMessageByIds({required String conversationId, required ConversationType type, required List<String> messageIds}) Future<void>
inherited
deleteLocalMessages({required int beforeTime}) Future<void>
inherited
deleteLocalThreadMessageById({required String threadId, required String messageId}) Future<void>
inherited
deleteReaction({required String messageId, required String reaction}) Future<void>
inherited
deleteRemoteConversation({required String conversationId, required ConversationType type, bool isDeleteMessage = true}) Future<void>
inherited
deleteRemoteMessagesBefore({required String conversationId, required ConversationType type, required int timestamp}) Future<void>
inherited
deleteRemoteMessagesWithIds({required String conversationId, required ConversationType type, required List<String> msgIds}) Future<void>
inherited
destroyChatRoom(String roomId) Future<void>
inherited
destroyChatThread({required String chatThreadId}) Future<void>
inherited
destroyGroup({required String groupId}) Future<void>
inherited
downloadAttachment({required Message message}) Future<void>
inherited
downloadGroupSharedFile({required String groupId, required String fileId, required String savePath}) Future<void>
inherited
downloadMessageAttachmentInCombine({required Message message}) Future<void>
inherited
downloadMessageThumbnailInCombine({required Message message}) Future<void>
inherited
downloadThumbnail({required Message message}) Future<void>
inherited
fetchAllBlockedContactIds() Future<List<String>>
inherited
fetchAllContactIds() Future<List<String>>
inherited
fetchAllContacts() Future<List<Contact>>
inherited
fetchChatRoomAllowListFromServer({required String roomId}) Future<List<String>>
inherited
fetchChatRoomAnnouncement({required String roomId}) Future<String?>
inherited
fetchChatRoomAttributes({required String roomId, List<String>? keys}) Future<Map<String, String>?>
inherited
fetchChatRoomBlockList({required String roomId, int pageNum = 1, int pageSize = 200}) Future<List<String>>
inherited
fetchChatRoomInfoFromServer({required String roomId, bool fetchMembers = false}) Future<ChatRoom>
inherited
fetchChatRoomMembers({required String roomId, String? cursor, int pageSize = 200}) Future<CursorResult<String>>
inherited
fetchChatRoomMuteList({required String roomId, int pageNum = 1, int pageSize = 200}) Future<List<String>>
inherited
fetchChatThread({required String chatThreadId}) Future<ChatThread?>
inherited
fetchChatThreadMembers({required String chatThreadId, String? cursor, int limit = 20}) Future<CursorResult<String>>
inherited
fetchChatThreadsWithParentId({required String parentId, String? cursor, int limit = 20}) Future<CursorResult<ChatThread>>
inherited
fetchCombineMessageDetail({required Message message}) Future<List<Message>>
inherited
fetchConversations({String? cursor, int pageSize = 20}) Future<CursorResult<Conversation>>
inherited
fetchGroupAckList({required String msgId, required String groupId, String? startAckId, int pageSize = 20}) Future<CursorResult<GroupMessageAck>>
inherited
fetchGroupAllowList(String groupId) Future<List<String>>
inherited
fetchGroupAnnouncement(String groupId) Future<String?>
inherited
fetchGroupBlockList({required String groupId, int pageSize = 200, int pageNum = 1}) Future<List<String>>
inherited
fetchGroupFileList({required String groupId, int pageSize = 200, int pageNum = 1}) Future<List<GroupSharedFile>>
inherited
fetchGroupInfo({required String groupId, bool fetchMembers = false}) Future<Group>
inherited
fetchGroupMemberAttributes({required String groupId, String? userId}) Future<Map<String, String>>
inherited
fetchGroupMemberIsInAllowList(String groupId) Future<bool>
inherited
fetchGroupMemberList({required String groupId, int pageSize = 200, String? cursor}) Future<CursorResult<String>>
inherited
fetchGroupMembersAttributes({required String groupId, required List<String> userIds, List<String>? keys}) Future<Map<String, Map<String, String>>>
inherited
fetchGroupMuteList({required String groupId, int pageSize = 200, int pageNum = 1}) Future<Map<String, int>>
inherited
fetchHistoryMessages({required String conversationId, ConversationType type = ConversationType.Chat, int pageSize = 20, SearchDirection direction = SearchDirection.Up, String startMsgId = ''}) Future<CursorResult<Message>>
inherited
fetchHistoryMessagesByOptions({required String conversationId, required ConversationType type, FetchMessageOptions? options, String? cursor, int pageSize = 50}) Future<CursorResult<Message>>
inherited
fetchJoinedChatThreads({String? cursor, int limit = 20}) Future<CursorResult<ChatThread>>
inherited
fetchJoinedChatThreadsWithParentId({required String parentId, String? cursor, int limit = 20}) Future<CursorResult<ChatThread>>
inherited
fetchJoinedGroupCount() Future<int>
inherited
fetchJoinedGroups({int pageSize = 20, int pageNum = 0, bool needMemberCount = false, bool needRole = false}) Future<List<Group>>
inherited
fetchLatestMessageWithChatThreads({required List<String> chatThreadIds}) Future<Map<String, Message>>
inherited
fetchOwnInfo({int expireTime = 0}) Future<UserInfo?>
inherited
fetchPinnedConversations({String? cursor, int pageSize = 20}) Future<CursorResult<Conversation>>
inherited
fetchPinnedMessages({required String conversationId}) Future<List<Message>>
inherited
fetchPresenceStatus({required List<String> members}) Future<List<Presence>>
inherited
fetchPublicChatRoomsFromServer({int pageNum = 1, int pageSize = 200}) Future<PageResult<ChatRoom>>
inherited
fetchPublicGroups({int pageSize = 20, String? cursor}) Future<CursorResult<GroupInfo>>
inherited
fetchPushConfig() Future<PushConfigs>
inherited
fetchReactionDetail({required String messageId, required String reaction, String? cursor, int pageSize = 20}) Future<CursorResult<MessageReaction>>
inherited
fetchReactionList({required List<String> messageIds, required ChatType type, String? groupId}) Future<Map<String, List<MessageReaction>>>
inherited
fetchSilentModel({required List<Conversation> conversations}) Future<Map<String, ChatSilentModeResult>>
inherited
fetchSubscribedMembers({int pageNum = 1, int pageSize = 20}) Future<List<String>>
inherited
fetchSupportedLanguages() Future<List<TranslateLanguage>>
inherited
fetchUserInfoByIds(List<String> userIds, {int expireTime = 0}) Future<Map<String, UserInfo>>
inherited
getAccessToken() Future<String>
inherited
getAllBlockedContactIds() Future<List<String>>
inherited
getAllContactIds() Future<List<String>>
inherited
getAllContacts() Future<List<Contact>>
inherited
getAllConversations() Future<List<Conversation>>
inherited
getAppointUnreadCount({required List<String> appointIds}) Future<int>
inherited
getChatRoomWithId(String roomId) Future<ChatRoom?>
inherited
getContact(String userId) Future<Contact?>
inherited
getConversation({required String conversationId, ConversationType type = ConversationType.Chat}) Future<Conversation?>
inherited
getGroup({required String groupId}) Future<Group?>
inherited
getJoinedGroups() Future<List<Group>>
inherited
getThreadConversation({required String conversationId}) Future<Conversation?>
inherited
getUnreadMessageCount({List<String>? withoutIds}) Future<int>
inherited
importMessages({required List<Message> messages}) Future<void>
inherited
init({required Options options}) Future<void>
override
insertMessage({required Message message, bool runMessageReceived = false, bool needUpdateConversationList = false}) Future<void>
inherited
inviterGroupMembers({required String groupId, required List<String> members, String? reason}) Future<void>
inherited
isConnect() Future<bool>
inherited
isLoginBefore() Future<bool>
Get current is logged
inherited
isMemberInChatRoomAllowList({required String roomId}) Future<bool>
inherited
joinChatRoom({required String roomId, bool leaveOther = true, String? ext}) Future<void>
inherited
joinChatThread({required String chatThreadId}) Future<ChatThread>
inherited
joinPublicGroup({required String groupId}) Future<void>
inherited
leaveChatRoom(String roomId) Future<void>
inherited
leaveChatThread({required String chatThreadId}) Future<void>
inherited
leaveGroup({required String groupId}) Future<void>
inherited
loadLocalMessages({required String conversationId, required ConversationType type, SearchDirection direction = SearchDirection.Up, String? startId, int count = 30}) Future<List<Message>>
inherited
loadLocalMessagesByTimestamp({required String conversationId, required ConversationType type, required int startTime, required int endTime, int count = 30}) Future<List<Message>>
inherited
loadMessage({required String messageId}) Future<Message?>
inherited
loadPinnedMessages({required String conversationId, required ConversationType type}) Future<List<Message>>
inherited
loginWithPassword({required String userId, required String password}) Future<void>
Login
override
loginWithToken({required String userId, required String token}) Future<void>
Login with token
override
logout() Future<void>
Logout
override
markAllConversationsAsRead() Future<void>
inherited
markConversationAsRead({required String conversationId}) Future<void>
inherited
modifyMessage({required String messageId, required TextMessageBody msgBody}) Future<Message>
inherited
muteAllChatRoomMembers({required String roomId}) Future<void>
inherited
muteChatRoomMembers({required String roomId, required List<String> muteMembers, int duration = -1}) Future<void>
inherited
muteGroupAllMembers({required String groupId}) Future<void>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onAdminAddedFromChatRoom(String roomId, String admin) → void
inherited
onAdminAddedFromGroup(String groupId, String admin) → void
inherited
onAdminRemovedFromChatRoom(String roomId, String admin) → void
inherited
onAdminRemovedFromGroup(String groupId, String admin) → void
inherited
onAllChatRoomMemberMuteStateChanged(String roomId, bool isAllMuted) → void
inherited
onAllGroupMemberMuteStateChanged(String groupId, bool isAllMuted) → void
inherited
onAllowListAddedFromChatRoom(String roomId, List<String> members) → void
inherited
onAllowListAddedFromGroup(String groupId, List<String> members) → void
inherited
onAllowListRemovedFromChatRoom(String roomId, List<String> members) → void
inherited
onAllowListRemovedFromGroup(String groupId, List<String> members) → void
inherited
onAnnouncementChangedFromChatRoom(String roomId, String announcement) → void
inherited
onAnnouncementChangedFromGroup(String groupId, String announcement) → void
inherited
onAttributesChangedOfGroupMember(String groupId, String userId, Map<String, String>? attributes, String? operatorId) → void
inherited
onAttributesRemoved(String roomId, List<String> removedKeys, String from) → void
inherited
onAttributesUpdated(String roomId, Map<String, String> attributes, String from) → void
inherited
onAutoAcceptInvitationFromGroup(String groupId, String inviter, String? inviteMessage) → void
inherited
onBlockedContactAdded(String userId) → void
inherited
onBlockedContactDeleted(String userId) → void
inherited
onChatRoomDestroyed(String roomId, String? roomName) → void
inherited
onChatSDKEventBegin(ChatSDKEvent event) → void
inherited
onChatSDKEventEnd(ChatSDKEvent event, ChatError? error) → void
inherited
onChatThreadCreate(ChatThreadEvent event) → void
inherited
onChatThreadDestroy(ChatThreadEvent event) → void
inherited
onChatThreadEvent(MultiDevicesEvent event, String chatThreadId, List<String> userIds) → void
inherited
onChatThreadUpdate(ChatThreadEvent event) → void
inherited
onChatUIKitEventsReceived(ChatUIKitEvent event) → void
inherited
onCmdMessagesReceived(List<Message> messages) → void
inherited
onContactAdded(String userId) → void
inherited
onContactDeleted(String userId) → void
inherited
onContactEvent(MultiDevicesEvent event, String userId, String? ext) → void
inherited
onContactRequestReceived(String userId, String? reason) → void
inherited
onConversationEvent(MultiDevicesEvent event, String conversationId, ConversationType type) → void
inherited
onConversationRead(String from, String to) → void
inherited
onConversationsUpdate() → void
inherited
onDisableChanged(String groupId, bool isDisable) → void
inherited
onError(String msgId, Message msg, ChatError error) → void
inherited
onFriendRequestAccepted(String userId) → void
inherited
onFriendRequestCountChanged(int count) → void
inherited
onFriendRequestDeclined(String userId) → void
inherited
onGroupCreatedByMyself(Group group) → void
inherited
onGroupDestroyed(String groupId, String? groupName) → void
inherited
onGroupEvent(MultiDevicesEvent event, String groupId, List<String>? userIds) → void
inherited
onGroupMessageRead(List<GroupMessageAck> groupMessageAcks) → void
inherited
onGroupNameChangedByMeSelf(Group group) → void
inherited
onInvitationAcceptedFromGroup(String groupId, String invitee, String? reason) → void
inherited
onInvitationDeclinedFromGroup(String groupId, String invitee, String? reason) → void
inherited
onInvitationReceivedFromGroup(String groupId, String? groupName, String inviter, String? reason) → void
inherited
onMemberExitedFromChatRoom(String roomId, String? roomName, String participant) → void
inherited
onMemberExitedFromGroup(String groupId, String member) → void
inherited
onMemberJoinedFromChatRoom(String roomId, String participant, String? ext) → void
inherited
onMemberJoinedFromGroup(String groupId, String member) → void
inherited
onMessageContentChanged(Message message, String operatorId, int operationTime) → void
inherited
onMessagePinChanged(String messageId, String conversationId, MessagePinOperation pinOperation, MessagePinInfo pinInfo) → void
inherited
onMessageReactionDidChange(List<MessageReactionEvent> events) → void
inherited
onMessagesDelivered(List<Message> messages) → void
inherited
onMessagesRead(List<Message> messages) → void
inherited
onMessagesRecalled(List<Message> messages) → void
inherited
onMessagesReceived(List<Message> messages) → void
inherited
onMessageUpdate(Message newMessage, [Message? oldMessage]) → void
inherited
onMuteListAddedFromChatRoom(String roomId, List<String> mutes, String? expireTime) → void
inherited
onMuteListAddedFromGroup(String groupId, List<String> mutes, int? muteExpire) → void
inherited
onMuteListRemovedFromChatRoom(String roomId, List<String> mutes) → void
inherited
onMuteListRemovedFromGroup(String groupId, List<String> mutes) → void
inherited
onOwnerChangedFromChatRoom(String roomId, String newOwner, String oldOwner) → void
inherited
onOwnerChangedFromGroup(String groupId, String newOwner, String oldOwner) → void
inherited
onPresenceStatusChanged(List<Presence> list) → void
inherited
onProgress(String msgId, int progress) → void
inherited
onReadAckForGroupMessageUpdated() → void
inherited
onRemoteMessagesRemoved(String conversationId, String deviceId) → void
inherited
onRemovedFromChatRoom(String roomId, String? roomName, String? participant, LeaveReason? reason) → void
inherited
onRequestToJoinAcceptedFromGroup(String groupId, String? groupName, String accepter) → void
inherited
onRequestToJoinDeclinedFromGroup(String groupId, String? groupName, String? decliner, String? reason, String? applicant) → void
inherited
onRequestToJoinReceivedFromGroup(String groupId, String? groupName, String applicant, String? reason) → void
inherited
onSharedFileAddedFromGroup(String groupId, GroupSharedFile sharedFile) → void
inherited
onSharedFileDeletedFromGroup(String groupId, String fileId) → void
inherited
onSpecificationChanged(ChatRoom room) → void
inherited
onSpecificationDidUpdate(Group group) → void
inherited
onSuccess(String msgId, Message msg) → void
inherited
onTypingMessagesReceived(List<Message> messages) → void
inherited
onUserKickOutOfChatThread(ChatThreadEvent event) → void
inherited
onUserRemovedFromGroup(String groupId, String? groupName) → void
inherited
pinConversation({required String conversationId, required bool isPinned}) Future<void>
inherited
pinMessage({required String messageId}) Future<void>
inherited
publishPresence(String description) Future<void>
inherited
recallMessage({required Message message}) Future<void>
inherited
removeAttributes({required String roomId, required List<String> keys, bool force = false}) Future<Map<String, int>?>
inherited
removeChatRoomAdmin({required String roomId, required String admin}) Future<void>
inherited
removeChatRoomMembers({required String roomId, required List<String> members}) Future<void>
inherited
removeGroupSharedFile({required String groupId, required String fileId}) Future<void>
inherited
removeListeners() → void
inherited
removeMemberFromChatThread({required String memberId, required String chatThreadId}) Future<void>
inherited
removeMembersFromChatRoomAllowList({required String roomId, required List<String> members}) Future<void>
inherited
removeObserver(ChatUIKitObserverBase observer) → void
inherited
reportMessage({required String messageId, required String tag, required String reason}) Future<void>
inherited
requestToJoinPublicGroup({required String groupId, String? reason}) Future<void>
inherited
resendMessage({required Message message}) Future<Message>
inherited
searchConversationLocalMessage({required String keywords, required String conversationId, ConversationType type = ConversationType.Chat, int timestamp = -1, int maxCount = 20, String? sender, SearchDirection direction = SearchDirection.Up}) Future<List<Message>>
inherited
searchLocalMessage({required String keywords, int timestamp = -1, int maxCount = 20, String? from, SearchDirection direction = SearchDirection.Up}) Future<List<Message>>
inherited
sendChatUIKitEvent(ChatUIKitEvent event) → void
inherited
sendContactRequest({required String userId, String? reason}) Future<void>
inherited
sendConversationReadAck({required String conversationId}) Future<void>
inherited
sendGroupMessageReadAck({required String msgId, required String groupId, String? content}) Future<void>
inherited
sendMessage({required Message message}) Future<Message>
inherited
sendMessageReadAck({required Message message}) Future<bool>
inherited
sendTyping({required String userId}) Future<void>
只支持单聊
inherited
setAllSilentMode({required ChatSilentModeParam param}) Future<void>
inherited
setGroupMemberAttributes({required String groupId, required Map<String, String> attributes, String? userId}) Future<void>
inherited
setSilentMode({required String conversationId, required ConversationType type, required ChatSilentModeParam param}) Future<void>
inherited
subscribe({required List<String> members, required int expiry}) Future<List<Presence>>
inherited
toString() String
A string representation of this object.
inherited
translateMessage({required Message msg, required List<String> languages}) Future<Message>
inherited
unBlockChatRoomMembers({required String roomId, required List<String> members}) Future<void>
inherited
unblockGroup({required String groupId}) Future<void>
inherited
unMuteAllChatRoomMembers({required String roomId}) Future<void>
inherited
unMuteChatRoomMembers({required String roomId, required List<String> unMuteMembers}) Future<void>
inherited
unMuteGroupAllMembers({required String groupId}) Future<void>
inherited
unpinMessage({required String messageId}) Future<void>
inherited
unsubscribe({required List<String> members}) Future<void>
inherited
updateChatRoomAnnouncement({required String roomId, required String announcement}) Future<void>
inherited
updateChatThreadName({required String chatThreadId, required String newName}) Future<void>
inherited
updateContactRemark(String userId, String remark) Future<void>
inherited
updateGroupAnnouncement({required String groupId, required String announcement}) Future<void>
inherited
updateGroupExtension({required String groupId, required String extension}) Future<void>
inherited
updateMessage({required Message message, bool runMessageUpdate = false, bool needUpdateConversationList = false}) Future<void>
inherited
updatePushDisplayStyle({required DisplayStyle style}) Future<void>
inherited
updateUserInfo({String? nickname, String? avatarUrl, String? mail, String? phone, int? gender, String? sign, String? birth, String? ext}) Future<void>
inherited
uploadAPNsPushToken({required String token}) Future<void>
inherited
uploadFCMPushToken({required String token}) Future<void>
inherited
uploadGroupSharedFile({required String groupId, required String filePath}) Future<void>
inherited
uploadHMSPushToken({required String token}) Future<void>
inherited
uploadPushDisplayName({required dynamic displayName}) Future<void>
inherited

Operators

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

Static Properties

instance ChatUIKit
no setter