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
acceptFriendApplication (String userID , ZIMFriendApplicationAcceptConfig config → Future <ZIMFriendApplicationAcceptedResult
Available since: 2.14.0 or above.
acceptGroupInviteApplication (String inviterUserID , String groupID , ZIMGroupInviteApplicationAcceptConfig config → Future <ZIMGroupInviteApplicationAcceptedResult
Available since: 2.15.0 and above.
acceptGroupJoinApplication (String userID , String groupID , ZIMGroupJoinApplicationAcceptConfig config → Future <ZIMGroupJoinApplicationAcceptedResult
Available since: 2.15.0 and above.
addFriend (String userID , ZIMFriendAddConfig config → Future <ZIMFriendAddedResult
Available since: 2.14.0 or above.
addMessageReaction (String reactionType , ZIMMessage message → Future <ZIMMessageReactionAddedResult
Available sinces: 2.10.0 and above.
addUsersToBlacklist (List <String userIDs → Future <ZIMBlacklistUsersAddedResult
Available since: 2.13.0 or above.
beginRoomAttributesBatchOperation (String roomID , ZIMRoomAttributesBatchOperationConfig config → void
Open combination room attribute operation.
callAccept (String callID , ZIMCallAcceptConfig config → Future <ZIMCallAcceptanceSentResult
Supported versions: 2.1.5 and above.
callCancel (List <String invitees , String callID , ZIMCallCancelConfig config → Future <ZIMCallCancelSentResult
Supported versions: 2.1.5 and above.
callEnd (String callID , ZIMCallEndConfig config → Future <ZIMCallEndSentResult
Supported versions: 2.9.0 and above.
callingInvite (List <String invitees , String callID , ZIMCallingInviteConfig config → Future <ZIMCallingInvitationSentResult
Supported versions: 2.9.0 and above.
callInvite (List <String invitees , ZIMCallInviteConfig config → Future <ZIMCallInvitationSentResult
Supported versions: 2.1.5 and above.
callJoin (String callID , ZIMCallJoinConfig config → Future <ZIMCallJoinSentResult
Available since: 2.12.0.
callQuit (String callID , ZIMCallQuitConfig config → Future <ZIMCallQuitSentResult
Supported versions: 2.9.0 and above.
callReject (String callID , ZIMCallRejectConfig config → Future <ZIMCallRejectionSentResult
Supported versions: 2.1.5 and above.
checkFriendsRelation (List <String userIDs , ZIMFriendRelationCheckConfig config → Future <ZIMFriendsRelationCheckedResult
Available since: 2.14.0 or above.
checkUserIsInBlacklist (String userID → Future <ZIMBlacklistCheckedResult
Available since: 2.13.0 or above.
clearConversationTotalUnreadMessageCount ()
→ Future <void >
Available since: 2.12.0 and above.
clearConversationUnreadMessageCount (String conversationID , ZIMConversationType conversationType → Future <ZIMConversationUnreadMessageCountClearedResult
Available since: 2.1.5 and above.
clearLocalFileCache (ZIMFileCacheClearConfig config → Future <void >
Supported versions: 2.15.0 and above.
createGroup (ZIMGroupInfo groupInfo , List <String userIDs , [ZIMGroupAdvancedConfig ?config → Future <ZIMGroupCreatedResult
Available since: 2.1.5 and above.
createRoom (ZIMRoomInfo roomInfo , [ZIMRoomAdvancedConfig ?config → Future <ZIMRoomCreatedResult
Create a room.
deleteAllConversationMessages (ZIMMessageDeleteConfig config → Future <void >
Supported versions: 2.14.0 and above.
deleteAllConversations (ZIMConversationDeleteConfig config → Future <void >
Available since: 2.12.0 and above.
deleteAllMessage (String conversationID , ZIMConversationType conversationType , ZIMMessageDeleteConfig config → Future <ZIMMessageDeletedResult
Supported versions: 2.1.5 and above.
deleteConversation (String conversationID , ZIMConversationType conversationType , ZIMConversationDeleteConfig config → Future <ZIMConversationDeletedResult
Available since: 2.1.5 and above.
deleteFriends (List <String userIDs , ZIMFriendDeleteConfig config → Future <ZIMFriendsDeletedResult
Available since: 2.14.0 or above.
deleteGroupAttributes (List <String keys , String groupID → Future <ZIMGroupAttributesOperatedResult
Available since: 2.0.0 and above.
deleteMessageReaction (String reactionType , ZIMMessage message → Future <ZIMMessageReactionDeletedResult
Available sinces: 2.10.0 and above.
deleteMessages (List <ZIMMessage messageList , String conversationID , ZIMConversationType conversationType , ZIMMessageDeleteConfig config → Future <ZIMMessageDeletedResult
Supported versions: 2.1.5 and above.
Detail description: This method implements the function of deleting messages.
Business scenario: The user needs to delete a message. When the user does not need to display a message, this method can be used to delete it.
Call timing/Notification timing: Called when the message needs to be deleted.
Note: The impact of deleting messages is limited to this account.
Restrictions: Effective after login, invalid after logout.
Scope of influence: If the deleted message is the latest message of the session, the ZIMEventHandler..onConversationChanged callback will be triggered, and if the message is unread, the ZIMEventHandler.onConversationTotalUnreadMessageCountUpdated callback will be triggered.
deleteRoomAttributes (List <String keys , String roomID , ZIMRoomAttributesDeleteConfig config → Future <ZIMRoomAttributesOperatedCallResult
Delete room attributes.
destroy ()
→ dynamic
Destroy the ZIM instance.
dismissGroup (String groupID → Future <ZIMGroupDismissedResult
Available since: 2.1.5 and above.
downloadMediaFile (ZIMMediaMessage message , ZIMMediaFileType fileType , ZIMMediaDownloadingProgress ?progress → Future <ZIMMediaDownloadedResult
Download media message content.
endRoomAttributesBatchOperation (String roomID → Future <ZIMRoomAttributesBatchOperatedResult
Complete the property operation of the combined room.
enterRoom (ZIMRoomInfo roomInfo , ZIMRoomAdvancedConfig config → Future <ZIMRoomEnteredResult
Supported version: 2.1.5.
exportLocalMessages (String folderPath , ZIMMessageExportConfig config , ZIMMessageExportingProgress ?progress → Future <void >
Supported versions: 2.15.0 and above.
importLocalMessages (String folderPath , ZIMMessageImportConfig config , ZIMMessageImportingProgress ?progress → Future <void >
insertMessageToLocalDB (ZIMMessage message , String conversationID , ZIMConversationType conversationType , String senderUserID → Future <ZIMMessageInsertedResult
Supported Versions: 2.4.0 and above.
inviteUsersIntoGroup (List <String userIDs , String groupID → Future <ZIMGroupUsersInvitedResult
Available since: 2.1.5 and above.
joinGroup (String groupID → Future <ZIMGroupJoinedResult
Available since: 2.1.5 and above.
joinRoom (String roomID → Future <ZIMRoomJoinedResult
Join a room.
kickGroupMembers (List <String userIDs , String groupID → Future <ZIMGroupMemberKickedResult
Available since: 2.1.5 and above.
leaveAllRoom ()
→ Future <ZIMRoomAllLeftResult
Available since: 2.15 and above.
leaveGroup (String groupID → Future <ZIMGroupLeftResult
Available since: 2.1.5 and above.
leaveRoom (String roomID → Future <ZIMRoomLeftResult
Leave a room.
login (String userID , ZIMLoginConfig config → Future <void >
Login, you must log in before using all functions.
userID Unique ID used to identify the user. Note that the userID must be unique under the same appID, otherwise mutual kicks out will occur.
config login config.
logout ()
→ dynamic
Log out of ZIM service.
muteGroup (bool isMute , String groupID , ZIMGroupMuteConfig config → Future <ZIMGroupMutedResult
Available since: 2.14.0 and above.
muteGroupMembers (bool isMute , List <String userIDs , String groupID , ZIMGroupMemberMuteConfig config → Future <ZIMGroupMembersMutedResult
Available since: 2.14.0 and above.
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
queryBlacklist (ZIMBlacklistQueryConfig config → Future <ZIMBlacklistQueriedResult
Available since: 2.13.0 or above.
queryCallInvitationList (ZIMCallInvitationQueryConfig config → Future <ZIMCallInvitationListQueriedResult
Supported versions: 2.9.0 and above.
queryCombineMessageDetail (ZIMCombineMessage message → Future <ZIMCombineMessageDetailQueriedResult
Available sinces: 2.14.0 and above.
queryConversation (String conversationID , ZIMConversationType conversationType → Future <ZIMConversationQueriedResult
Available since: 2.8.0 and above.
queryConversationList (ZIMConversationQueryConfig config → Future <ZIMConversationListQueriedResult
Available since: 2.1.5 and above.
Description: This method displays the session list of the logged in user.
Use cases: This interface can be invoked to get the data source when you need to display an existing message session after logging in.
queryConversationPinnedList (ZIMConversationQueryConfig config → Future <ZIMConversationPinnedListQueriedResult
Available since: 2.8.0 and above.
queryFriendApplicationList (ZIMFriendApplicationListQueryConfig config → Future <ZIMFriendApplicationListQueriedResult
Available since: 2.14.0 or above.
queryFriendList (ZIMFriendListQueryConfig config → Future <ZIMFriendListQueriedResult
Available since: 2.14.0 or above.
queryFriendsInfo (List <String userIDs → Future <ZIMFriendsInfoQueriedResult
Available since: 2.14.0 or above.
queryGroupAllAttributes (String groupID → Future <ZIMGroupAttributesQueriedResult
Available since: 2.1.5 and above.
queryGroupApplicationList (ZIMGroupApplicationListQueryConfig config → Future <ZIMGroupApplicationListQueriedResult
Available since: 2.15.0 and above.
queryGroupAttributes (List <String keys , String groupID → Future <ZIMGroupAttributesQueriedResult
Available since: 2.1.5 and above.
queryGroupInfo (String groupID → Future <ZIMGroupInfoQueriedResult
Available since: 2.1.5 and above.
queryGroupList ()
→ Future <ZIMGroupListQueriedResult
Available since: 2.1.5 and above.
queryGroupMemberCount (String groupID → Future <ZIMGroupMemberCountQueriedResult
Available since: 2.2.0 or above.
queryGroupMemberInfo (String userID , String groupID → Future <ZIMGroupMemberInfoQueriedResult
Available since: 2.1.5 and above.
queryGroupMemberList (String groupID , ZIMGroupMemberQueryConfig config → Future <ZIMGroupMemberListQueriedResult
Available since: 2.1.5 and above.
queryGroupMemberMutedList (String groupID , ZIMGroupMemberMutedListQueryConfig config → Future <ZIMGroupMemberMutedListQueriedResult
Available since: 2.14.0 and above.
queryGroupMessageReceiptReadMemberList (ZIMMessage message , String groupID , ZIMGroupMessageReceiptMemberQueryConfig config → Future <ZIMGroupMessageReceiptMemberListQueriedResult
Available since: 2.5.0 and above.
queryGroupMessageReceiptUnreadMemberList (ZIMMessage message , String groupID , ZIMGroupMessageReceiptMemberQueryConfig config → Future <ZIMGroupMessageReceiptMemberListQueriedResult
Available since: 2.5.0 and above.
queryHistoryMessage (String conversationID , ZIMConversationType conversationType , ZIMMessageQueryConfig config → Future <ZIMMessageQueriedResult
Supported versions: 2.1.5 and above.
Detailed description: This method is used to query historical messages.
Business scenario: When you need to obtain past historical messages, you can call this interface to query historical messages by paging.
Call timing/Notification timing: Called when historical messages need to be queried.
Restrictions: Effective after login, invalid after logout.
queryLocalFileCache (ZIMFileCacheQueryConfig config → Future <ZIMFileCacheQueriedResult
Supported versions: 2.15.0 and above.
queryMessageReactionUserList (ZIMMessage message , ZIMMessageReactionUsersQueryConfig config → Future <ZIMMessageReactionUserListQueriedResult
Available sinces: 2.10.0 and above.
queryMessageReceiptsInfo (List <ZIMMessage messageList , String conversationID , ZIMConversationType conversationType → Future <ZIMMessageReceiptsInfoQueriedResult
Available since: 2.5.0 and above.
queryRoomAllAttributes (String roomID → Future <ZIMRoomAttributesQueriedResult
Query all properties of the room.
queryRoomMemberAttributesList (String roomID , ZIMRoomMemberAttributesQueryConfig config → Future <ZIMRoomMemberAttributesListQueriedResult
Available since:2.4.0 or later.
queryRoomMemberList (String roomID , ZIMRoomMemberQueryConfig config → Future <ZIMRoomMemberQueriedResult
Query the list of members in the room.
queryRoomMembers (List <String userIDs , String roomID → Future <ZIMRoomMembersQueriedResult
Available since: 2.8.0 and above.
queryRoomMembersAttributes (List <String userIDs , String roomID → Future <ZIMRoomMembersAttributesQueriedResult
Available since:2.4.0 or later.
queryRoomOnlineMemberCount (String roomID → Future <ZIMRoomOnlineMemberCountQueriedResult
Query the number of online members in the room.
querySelfUserInfo ()
→ Future <ZIMSelfUserInfoQueriedResult
Available since: 2.15.0 and later versions.
queryUsersInfo (List <String userIDs , ZIMUserInfoQueryConfig config → Future <ZIMUsersInfoQueriedResult
Available since: 2.1.5 and above.
rejectFriendApplication (String userID , ZIMFriendApplicationRejectConfig config → Future <ZIMFriendApplicationRejectedResult
Available since: 2.14.0 or above.
rejectGroupInviteApplication (String inviterUserID , String groupID , ZIMGroupInviteApplicationRejectConfig config → Future <ZIMGroupInviteApplicationRejectedResult
Available since: 2.15.0 and above.
rejectGroupJoinApplication (String userID , String groupID , ZIMGroupJoinApplicationRejectConfig config → Future <ZIMGroupJoinApplicationRejectedResult
Available since: 2.15.0 and above.
removeUsersFromBlacklist (List <String userIDs → Future <ZIMBlacklistUsersRemovedResult
Available since: 2.13.0 or above.
renewToken (String token → Future <ZIMTokenRenewedResult
Update the authentication token.
revokeMessage (ZIMMessage message , ZIMMessageRevokeConfig config → Future <ZIMMessageRevokedResult
Available sinces: 2.5.0 and above.
searchGlobalLocalMessages (ZIMMessageSearchConfig config → Future <ZIMMessagesGlobalSearchedResult
Supported versions: 2.9.0 and above.
searchLocalConversations (ZIMConversationSearchConfig config → Future <ZIMConversationsSearchedResult
Supported versions: 2.9.0 and above.
searchLocalFriends (ZIMFriendSearchConfig config → Future <ZIMFriendsSearchedResult
Available since: 2.14.0 or above.
searchLocalGroupMembers (String groupID , ZIMGroupMemberSearchConfig config → Future <ZIMGroupMembersSearchedResult
Supported versions: 2.9.0 and above.
searchLocalGroups (ZIMGroupSearchConfig config → Future <ZIMGroupsSearchedResult
Supported versions: 2.9.0 and above.
searchLocalMessages (String conversationID , ZIMConversationType conversationType , ZIMMessageSearchConfig config → Future <ZIMMessagesSearchedResult
Supported versions: 2.9.0 and above.
sendConversationMessageReceiptRead (String conversationID , ZIMConversationType conversationType → Future <ZIMConversationMessageReceiptReadSentResult
Available since: 2.5.0 and above.
sendFriendApplication (String userID , ZIMFriendApplicationSendConfig config → Future <ZIMFriendApplicationSentResult
Supported versions: 2.14.0 and above.
sendGroupInviteApplications (List <String userIDs , String groupID , ZIMGroupInviteApplicationSendConfig config → Future <ZIMGroupInviteApplicationsSentResult
Available since: 2.15.0 and above.
sendGroupJoinApplication (String groupID , ZIMGroupJoinApplicationSendConfig config → Future <ZIMGroupJoinApplicationSentResult
Available since: 2.15.0 and above.
sendGroupMessage (ZIMMessage message , String toGroupID , ZIMMessageSendConfig config → Future <ZIMMessageSentResult
deprecated: This API has been deprecated since 2.4.0, please use sendMessage instead.
sendMediaMessage (ZIMMediaMessage message , String toConversationID , ZIMConversationType conversationType , ZIMMessageSendConfig config , ZIMMediaMessageSendNotification ?notification → Future <ZIMMessageSentResult
Send media messages.
Supported versions: 2.1.5 and above.
sendMessage (ZIMMessage message , String toConversationID , ZIMConversationType conversationType , ZIMMessageSendConfig config , [ZIMMessageSendNotification ?notification → Future <ZIMMessageSentResult
Supported versions: 2.4.0 and above.
sendMessageReceiptsRead (List <ZIMMessage messageList , String conversationID , ZIMConversationType conversationType → Future <ZIMMessageReceiptsReadSentResult
Available since: 2.5.0 and above.
Description: This method can set the receipt of a batch of messages to become read.
Use cases: Developers can use this method to set a batch of messages with receipts that have been read. If the sender is online, it will receive the onMessageReceiptChanged callback.
When to call: Callable after login. It is recommended to set the settings for the messages that need to be read on the message list page. It is not recommended to mix with sendConversationMessageReceiptRead .
Restrictions: Only support the settings for received messages with receipt status as PROCESSING.
Related callbacks: ZIMMessageReceiptsReadSentResult.
Related APIs: sendMessage .
sendPeerMessage (ZIMMessage message , String toUserID , ZIMMessageSendConfig config → Future <ZIMMessageSentResult
deprecated: This API has been deprecated since 2.4.0, please use sendMessage instead.
sendRoomMessage (ZIMMessage message , String toRoomID , ZIMMessageSendConfig config → Future <ZIMMessageSentResult
deprecated: This API has been deprecated since 2.4.0, please use sendMessage instead.
setConversationDraft (String draft , String conversationID , ZIMConversationType conversationType → Future <ZIMConversationDraftSetResult
Available since: 2.14.0 and above.
setConversationNotificationStatus (ZIMConversationNotificationStatus status , String conversationID , ZIMConversationType conversationType → Future <ZIMConversationNotificationStatusSetResult
Available since: 2.1.5 and above.
setGroupAttributes (Map <String String groupAttributes , String groupID → Future <ZIMGroupAttributesOperatedResult
Available since: 2.1.5 and above.
setGroupMemberNickname (String nickname , String forUserID , String groupID → Future <ZIMGroupMemberNicknameUpdatedResult
Available since: 2.1.5 and above.
setGroupMemberRole (int role , String forUserID , String groupID → Future <ZIMGroupMemberRoleUpdatedResult
Available since: 2.1.5 and above.
setRoomAttributes (Map <String String roomAttributes , String roomID , ZIMRoomAttributesSetConfig config → Future <ZIMRoomAttributesOperatedCallResult
Set room attributes (use this for all additions and changes).
setRoomMembersAttributes (Map <String String attributes , List <String userIDs , String roomID , ZIMRoomMemberAttributesSetConfig config → Future <ZIMRoomMembersAttributesOperatedResult
Supported Versions: 2.4.0 and above.
toString ()
→ String
A string representation of this object.
inherited
transferGroupOwner (String toUserID , String groupID → Future <ZIMGroupOwnerTransferredResult
Available since: 2.1.5 and above.
updateConversationPinnedState (bool isPinned , String conversationID , ZIMConversationType conversationType → Future <ZIMConversationPinnedStateUpdatedResult
Available since: 2.8.0 and above.
updateFriendAlias (String friendAlias , String userID → Future <ZIMFriendAliasUpdatedResult
Available since: 2.14.0 or above.
updateFriendAttributes (Map <String String friendAttributes , String userID → Future <ZIMFriendAttributesUpdatedResult
Available since: 2.14.0 or above.
updateGroupAvatarUrl (String groupAvatarUrl , String groupID → Future <ZIMGroupAvatarUrlUpdatedResult
Supported versions: 2.3.0 and above.
updateGroupBeInviteMode (ZIMGroupBeInviteMode mode , String groupID → Future <ZIMGroupBeInviteModeUpdatedResult
Available since: 2.15.0 and above.
updateGroupInviteMode (ZIMGroupInviteMode mode , String groupID → Future <ZIMGroupInviteModeUpdatedResult
Available since: 2.15.0 and above.
updateGroupJoinMode (ZIMGroupJoinMode mode , String groupID → Future <ZIMGroupJoinModeUpdatedResult
Available since: 2.15.0 and above.
updateGroupName (String groupName , String groupID → Future <ZIMGroupNameUpdatedResult
Available since: 2.1.5 and above.
updateGroupNotice (String groupNotice , String groupID → Future <ZIMGroupNoticeUpdatedResult
Available since: 2.1.5 and above.
updateMessageLocalExtendedData (String localExtendedData , ZIMMessage message → Future <ZIMMessageLocalExtendedDataUpdatedResult
Available since: 2.2.0 or above.
updateUserAvatarUrl (String userAvatarUrl → Future <ZIMUserAvatarUrlUpdatedResult
Available since: 2.3.0 and above.
updateUserExtendedData (String extendedData → Future <ZIMUserExtendedDataUpdatedResult
Available since: 2.2.0 and above.
updateUserName (String userName → Future <ZIMUserNameUpdatedResult
Available since: 2.2.0 and above.
updateUserOfflinePushRule (ZIMUserOfflinePushRule offlinePushRule → Future <ZIMUserOfflinePushRuleUpdatedResult
Available since: 2.15.0 and later versions.
uploadLog ()
→ Future <void >
Upload log and call after setting up log path.
