ZIMKit class Get started APIs Events Configs

Mixed in types

• ZIMKitConversationService
• ZIMKitUserService
• ZIMKitMessageService
• ZIMKitInputService
• ZIMKitGroupService
• ZIMKitHelperService

Available Extensions

• ZIMKitDefaultDialogService

Constructors

ZIMKit()

factory

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

addMessageReaction(ZIMKitMessage message, String reactionType) → Future<void>

inherited

addUersToGroup(String conversationID, List<String> userIDs) → Future<int>

inherited

clearUnreadCount(String conversationID, ZIMConversationType conversationType) → Future<void>

inherited

connectUser({required String id, String name = '', String avatarUrl = ''}) → Future<int>

inherited

createGroup(String name, List<String> inviteUserIDs, {String id = ''}) → Future<String?>

inherited

currentUser() → ZIMUserFullInfo?

inherited

deleteAllConversation({bool isAlsoDeleteFromServer = true, bool isAlsoDeleteMessages = false}) → Future<void>

inherited

deleteAllMessage({required String conversationID, required ZIMConversationType conversationType, required bool isAlsoDeleteServerMessage}) → Future<void>

inherited

deleteConversation(String id, ZIMConversationType type, {bool isAlsoDeleteMessages = false, bool isAlsoDeleteFromServer = true}) → Future<void>

inherited

deleteMessage(List<ZIMKitMessage> messages) → Future<void>

inherited

deleteMessageReaction(ZIMKitMessage message, String reactionType) → Future<void>

inherited

disbandGroup(String conversationID) → Future<int>

inherited

disconnectUser() → Future<void>

inherited

downloadMediaFile(ZIMKitMessage message) → void

inherited

getConnectionStateChangedEventStream() → Stream<ZegoSignalingPluginConnectionStateChangedEvent>

inherited

getConversation(String id, ZIMConversationType type) → ValueNotifier<ZIMKitConversation>

inherited

getConversationListNotifier() → Future<ZIMKitConversationListNotifier>

inherited

getGroupAttributesUpdatedEventStream() → Stream<ZIMKitEventGroupAttributesUpdated>

inherited

getGroupAvatarUrlUpdatedEventStream() → Stream<ZIMKitEventGroupAvatarUrlUpdated>

inherited

getGroupMemberInfoUpdatedEventStream() → Stream<ZIMKitEventGroupMemberInfoUpdated>

inherited

getGroupMemberStateChangedEventStream() → Stream<ZIMKitEventGroupMemberStateChanged>

inherited

getGroupNameUpdatedEventStream() → Stream<ZIMKitEventGroupNameUpdated>

inherited

getGroupNoticeUpdatedEventStream() → Stream<ZIMKitEventGroupNoticeUpdated>

inherited

getGroupStateChangedEventStream() → Stream<ZIMKitEventGroupStateChanged>

inherited

getMessageListNotifier(String conversationID, ZIMConversationType type) → Future<ZIMKitMessageListNotifier>

inherited

getMessageTypeByFileExtension(PlatformFile file) → ZIMMessageType

inherited

getOnMessageReceivedNotifier() → ValueNotifier<ZIMKitReceivedMessages?>

inherited

getTotalUnreadMessageCount() → ValueNotifier<int>

inherited

init({required int appID, String appSign = '', String appSecret = '', ZegoZIMKitNotificationConfig? notificationConfig}) → Future<void>

isAppLocked() → Future<bool>

inherited

joinGroup(String conversationID) → Future<int>

inherited

leaveGroup(String conversationID) → Future<int>

inherited

loadMoreConversation() → Future<int>

inherited

loadMoreMessage(String conversationID, ZIMConversationType conversationType) → Future<int>

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pickFiles({FileType type = FileType.any, bool allowMultiple = true}) → Future<List<PlatformFile>>

inherited

queryGroupInfo(String conversationID) → ValueNotifier<ZIMKitGroupInfo>

inherited

queryGroupMemberCount(String conversationID) → ValueNotifier<int>

inherited

queryGroupMemberInfo(String conversationID, String userID) → Future<ZIMGroupMemberInfo?>

inherited

queryGroupMemberList(String conversationID) → ListNotifier<ZIMGroupMemberInfo>

inherited

queryGroupOwner(String conversationID) → ValueNotifier<ZIMGroupMemberInfo?>

inherited

queryUser(String id) → Future<ZIMUserFullInfo>

inherited

recallMessage(ZIMKitMessage message) → Future<void>

inherited

registerAppLifecycleStateChangedListener(ZegoPluginAdapterMessageHandler listener) → void

inherited

removeUesrsFromGroup(String conversationID, List<String> userIDs) → Future<int>

inherited

requestPermission() → Future<void>

inherited

sendCustomMessage(String conversationID, ZIMConversationType type, {required int customType, required String customMessage, String? searchedContent, FutureOr<ZIMKitMessage> preMessageSending(ZIMKitMessage)?, dynamic onMessageSent(ZIMKitMessage)?}) → Future<void>

inherited

sendFileMessage(String conversationID, ZIMConversationType type, List<PlatformFile> files, {bool autoDetectType = true, ZIMMediaUploadingProgress? mediaUploadingProgress, FutureOr<ZIMKitMessage> preMessageSending(ZIMKitMessage)?, dynamic onMessageSent(ZIMKitMessage)?}) → Future<void>

inherited

sendMediaMessage(String conversationID, ZIMConversationType type, List<PlatformFile> files, {ZIMMediaUploadingProgress? mediaUploadingProgress, FutureOr<ZIMKitMessage> preMessageSending(ZIMKitMessage)?, dynamic onMessageSent(ZIMKitMessage)?}) → Future<void>

inherited

sendTextMessage(String conversationID, ZIMConversationType type, String text, {FutureOr<ZIMKitMessage> preMessageSending(ZIMKitMessage)?, dynamic onMessageSent(ZIMKitMessage)?}) → Future<void>

inherited

setGroupMemberRole({required String conversationID, required String userID, required int role}) → Future<int>

inherited

toString() → String

A string representation of this object.

inherited

transferGroupOwner(String conversationID, String toUserID) → Future<int>

inherited

uninit() → Future<void>

unregisterAppLifecycleStateChangedListener(ZegoPluginAdapterMessageHandler listener) → void

inherited

updateLocalExtendedData(ZIMKitMessage message, String localExtendedData) → Future<void>

inherited

updateUserInfo({String name = '', String avatarUrl = ''}) → Future<int>

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

instance → ZIMKit

final