FlutterImclient class

Constructors

FlutterImclient()

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

clientId → Future<String?>

客户端ID，客户端的唯一标示。获取IM Token时必须带上正确的客户端ID，否则会无法连接成功。

no setter

connectionStatus → Future<int?>

连接状态

no setter

currentUserId → Future<String?>

当前用户ID

no setter

IMEventBus → EventBus

no setter

isLogined → Future<bool?>

客户端是否调用过connect

no setter

logFilesPath → Future<List<String>>

获取协议栈日志文件路径

no setter

serverDeltaTime → Future<int?>

当前服务器与客户端时间的差值，单位是毫秒，只能是初略估计，不精确。

no setter

Static Methods

addGroupMembers(String groupId, List<String> members, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

添加群成员

allowGroupMember(String groupId, bool isSet, List<String> memberIds, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

设置/取消群白名单

beginTransaction() → Future<bool?>

开启协议栈数据库事物，仅当数据迁移功能使用

clearConversationsUnreadStatus(List<ConversationType> types, List<int> lines) → Future<bool>

清除某些类型会话的未读状态

clearConversationUnreadStatus(Conversation conversation) → Future<bool>

清除一个会话的未读状态

clearMessages(Conversation conversation, {int before = 0}) → Future<bool?>

清空会话内消息

clearNoDisturbingTimes(OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

取消免打扰时间段

clearUnreadFriendRequestStatus() → Future<bool>

清除未读好友请求计数

commitTransaction() → Future<void>

提交协议栈数据库事物，仅当数据迁移功能使用

connect(String host, String userId, String token) → Future<bool?>

连接IM服务。调用连接之后才可以调用获取数据接口。连接状态会通过连接状态回调返回。 host为IM服务域名或IP，必须im.example.com或114.144.114.144，不带http头和端口。

convertDynamicList(List? datas) → List<String>

createChannel(String channelName, String channelPortrait, int status, String desc, String extra, OperationSuccessChannelInfoCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

创建频道

createGroup(String groupId, String groupName, String groupPortrait, int type, List<String> members, OperationSuccessStringCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

创建群组，groupId可以为空。

decodeMessageContent(MessagePayload payload) → MessageContent

deleteFileRecord(int messageUid, int count, OperationSuccessFilesCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

删除文件记录

deleteFriend(String userId, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

删除好友

deleteMessage(int messageId) → Future<bool?>

删除消息

destoryChannel(String channelId, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

销毁频道

disconnect({bool disablePush = false, bool clearSession = false}) → Future<void>

断开IM服务连接。

dismissGroup(String groupId, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

解散群组

getAuthorizedMediaUrl(String mediaPath, int messageUid, int mediaType, OperationSuccessStringCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

获取经过授权的媒体路径

getBlackList({bool refresh = false}) → Future<List<String>>

获取黑名单列表

getChannelInfo(String channelId, {bool refresh = false}) → Future<ChannelInfo>

获取频道信息

getChatroomInfo(String chatroomId, int updateDt, OperationSuccessChatroomInfoCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

获取聊天室信息

getChatroomMemberInfo(String chatroomId, OperationSuccessChatroomMemberInfoCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

获取聊天室成员信息

getConversationFiles(int beforeMessageUid, int count, OperationSuccessFilesCallback successCallback, OperationFailureCallback errorCallback, {required Conversation conversation, String? fromUser}) → Future<void>

获取会话文件记录

getConversationInfo(Conversation conversation) → Future<ConversationInfo>

获取会话信息

getConversationInfos(List<ConversationType> types, List<int> lines) → Future<List<ConversationInfo>>

获取会话列表

getConversationRead(Conversation conversation) → Future<Map<String, int>>

获取会话的已读状态

getConversationsMessageByStatus(List<ConversationType> types, List<int> lines, int fromIndex, int count, List<MessageStatus> messageStatus, {String? withUser}) → Future<List<Message?>>

根据消息状态获取某些类型会话的消息列表

getConversationsMessages(List<ConversationType> types, List<int> lines, int fromIndex, int count, {List<int>? contentTypes, String? withUser}) → Future<List<Message?>>

获取某些类型会话的消息列表

getConversationsUnreadCount(List<ConversationType> types, List<int> lines) → Future<UnreadCount?>

设置某些类型会话未读状态

getConversationUnreadCount(Conversation conversation) → Future<UnreadCount?>

设置会话未读状态

getFavGroups() → Future<List<String>>

获取收藏群组列表

getFavUsers() → Future<List<String>>

获取收藏好友列表

getFirstUnreadMessageId(Conversation conversation) → Future<int?>

设置会话中第一个未读消息ID

getFriendAlias(String userId) → Future<String?>

获取好友备注名

getFriendExtra(String userId) → Future<String?>

获取好友extra信息

getFriendRequest(String userId, FriendRequestDirection direction) → Future<FriendRequest>

获取某个用户相关的好友请求

getGroupInfo(String groupId, {bool refresh = false}) → Future<GroupInfo?>

获取群信息

getGroupInfoAsync(String groupId, {bool refresh = false, OperationSuccessGroupInfoCallback? successCallback, OperationFailureCallback? errorCallback}) → Future<void>

异步获取群信息

getGroupMember(String groupId, String memberId) → Future<GroupMember>

获取单个群成员信息

getGroupMembers(String groupId, {bool refresh = false}) → Future<List<GroupMember>>

获取群成员列表

getGroupMembersAsync(String groupId, {bool refresh = false, OperationSuccessGroupMembersCallback? successCallback, OperationFailureCallback? errorCallback}) → Future<void>

异步获取群成员列表

getGroupMembersByTypes(String groupId, GroupMemberType memberType) → Future<List<GroupMember>>

根据群成员类型获取群成员列表

getIncommingFriendRequest() → Future<List<FriendRequest>>

获取收到的好友请求列表

getListenedChannels() → Future<List<String>>

获取我订阅的频道

getMessage(int messageId) → Future<Message?>

根据消息Id获取消息

getMessageByUid(int messageUid) → Future<Message?>

根据消息Uid获取消息

getMessageCount(Conversation conversation) → Future<int?>

获取会话内消息数量

getMessageDelivery(Conversation conversation) → Future<Map<String, int>>

获取会话的消息送达状态

getMessages(Conversation conversation, int fromIndex, int count, {List<int>? contentTypes, String? withUser}) → Future<List<Message?>>

获取会话的消息列表

getMessagesByStatus(Conversation conversation, int fromIndex, int count, List<MessageStatus> messageStatus, {String? withUser}) → Future<List<Message?>>

根据消息状态获取会话的消息列表

getMyChannels() → Future<List<String>>

获取我的频道

getMyFiles(int beforeMessageUid, int count, OperationSuccessFilesCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

获取我的文件记录

getMyFriendList({bool refresh = false}) → Future<List<String>>

获取好友列表

getNoDisturbingTimes(OperationSuccessIntPairCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

获取免打扰时间段

getOnlineInfos() → Future<List<OnlineInfo>>

获取PC端在线状态

getOutgoingFriendRequest() → Future<List<FriendRequest>>

获取发出去的好友请求列表

getRemoteMessages(Conversation conversation, int beforeMessageUid, int count, OperationSuccessMessagesCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

获取远端历史消息

getUnreadFriendRequestStatus() → Future<int?>

获取未读好友请求数

getUserInfo(String? userId, {String? groupId, bool refresh = false}) → Future<UserInfo?>

获取用户信息

getUserInfoAsync(String userId, OperationSuccessUserInfoCallback successCallback, OperationFailureCallback errorCallback, {bool refresh = false}) → Future<void>

异步获取用户信息

getUserInfos(List<String> userIds, {String? groupId}) → Future<List<UserInfo?>>

批量获取用户信息

getUserSetting(int scope, String value) → Future<String?>

获取用户设置

getUserSettings(int scope) → Future<Map<String, String>?>

获取某类用户设置

getWavData(String amrPath) → Future<Uint8List?>

转换amr数据为wav数据，仅在iOS平台有效

handleFriendRequest(String userId, bool accept, String extra, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

处理好友请求

init(ConnectionStatusChangedCallback connectionStatusChangedCallback, ReceiveMessageCallback receiveMessageCallback, RecallMessageCallback recallMessageCallback, DeleteMessageCallback deleteMessageCallback, {MessageDeliveriedCallback? messageDeliveriedCallback, MessageReadedCallback? messageReadedCallback, GroupInfoUpdatedCallback? groupInfoUpdatedCallback, GroupMemberUpdatedCallback? groupMemberUpdatedCallback, UserInfoUpdatedCallback? userInfoUpdatedCallback, FriendListUpdatedCallback? friendListUpdatedCallback, FriendRequestListUpdatedCallback? friendRequestListUpdatedCallback, UserSettingsUpdatedCallback? userSettingsUpdatedCallback, ChannelInfoUpdatedCallback? channelInfoUpdatedCallback}) → void

初始化SDK。必须在程序启动之后在所有操作之前初始化，之后才可以做其它操作。

insertMessage(Conversation conversation, String sender, MessageContent content, int status, int serverTime) → Future<Message?>

插入消息

isBlackListed(String userId) → Future<bool?>

是否是黑名单用户

isCommercialServer() → Future<bool?>

是否是专业版

isFavGroup(String groupId) → Future<bool?>

是否收藏群组

isFavUser(String userId) → Future<bool?>

是否是收藏用户

isGlobalSlient() → Future<bool?>

是否全局静音

isHiddenGroupMemberName(String groupId) → Future<bool?>

是否群组隐藏用户名

isHiddenNotificationDetail() → Future<bool?>

是否推送隐藏详情

isListenedChannel(String channelId) → Future<bool?>

是否是已订阅频道

isMuteNotificationWhenPcOnline() → Future<bool?>

是否设置当PC在线时停止手机通知

isMyFriend(String userId) → Future<bool?>

是否是好友

isReceiptEnabled() → Future<bool?>

服务是否支持消息回执

isUserEnableReceipt() → Future<bool?>

当前用户是否启用回执功能

joinChatroom(String chatroomId, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

加入聊天室

kickoffGroupMembers(String groupId, List<String> members, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

移除群成员

kickoffPCClient(String clientId, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

踢掉PC客户端

listenChannel(String channelId, bool isListen, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

订阅/取消订阅频道

loadFriendRequestFromRemote() → Future<void>

同步远程好友请求信息

modifyChannelInfo(String channelId, ModifyChannelInfoType modifyType, String newValue, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

修改频道信息

modifyGroupAlias(String groupId, String newAlias, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

修改自己的群名片

modifyGroupInfo(String groupId, ModifyGroupInfoType modifyType, String newValue, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

修改群组信息

modifyGroupMemberAlias(String groupId, String memberId, String newAlias, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

修改群成员的群名片

modifyMyInfo(Map<ModifyMyInfoType, String> values, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

修改当前用户信息

muteGroupMember(String groupId, bool isSet, List<String> memberIds, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

禁言/取消禁言群成员

muteNotificationWhenPcOnline(bool isMute, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置/取消设置当PC在线时停止手机通知

quitChatroom(String chatroomId, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

退出聊天室

quitGroup(String groupId, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

退出群组

recallMessage(int messageUid, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

撤回消息

registeMessageContent(MessageContentMeta contentMeta) → void

注册消息，所有的预制消息和自定义消息都必须先注册才可以使用。

removeConversation(Conversation conversation, bool clearMessage) → Future<void>

移除会话

searchChannel(String keyword, OperationSuccessChannelInfosCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

搜索频道

searchConversation(String keyword, List<ConversationType> types, List<int> lines) → Future<List<ConversationSearchInfo>>

搜索会话信息

searchConversationsMessages(List<ConversationType> types, List<int> lines, String keyword, int fromIndex, int count, {List<int>? contentTypes}) → Future<List<Message?>>

搜索某些类会话内消息

searchFiles(String keyword, int beforeMessageUid, int count, OperationSuccessFilesCallback successCallback, OperationFailureCallback errorCallback, {required Conversation conversation, String? fromUser}) → Future<void>

搜索文件记录

searchFriends(String keyword) → Future<List<UserInfo?>>

搜索好友

searchGroups(String keyword) → Future<List<GroupSearchInfo>>

搜索群组

searchMessages(Conversation conversation, String keyword, bool order, int limit, int offset) → Future<List<Message?>>

搜索某个会话内消息

searchMyFiles(String keyword, int beforeMessageUid, int count, OperationSuccessFilesCallback? successCallback, OperationFailureCallback? errorCallback) → Future<void>

搜索我的文件记录

searchUser(String keyword, int searchType, int page, OperationSuccessUserInfosCallback successCallback, OperationFailureCallback errorCallback) → Future<List<UserInfo?>>

搜索用户

sendFriendRequest(String userId, String reason, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

发送好友请求

sendMediaMessage(Conversation conversation, MessageContent content, {List<String>? toUsers, required int expireDuration, SendMessageSuccessCallback? successCallback, OperationFailureCallback? errorCallback, SendMediaMessageProgressCallback? progressCallback, SendMediaMessageUploadedCallback? uploadedCallback}) → Future<Message?>

发送媒体类型消息

sendMessage(Conversation conversation, MessageContent content, {List<String>? toUsers, int expireDuration = 0, SendMessageSuccessCallback? successCallback, OperationFailureCallback? errorCallback}) → Future<Message?>

发送消息

sendSavedMessage(int messageId, {int? expireDuration, SendMessageSuccessCallback? successCallback, OperationFailureCallback? errorCallback}) → Future<bool?>

发送已保存消息

setBlackList(String userId, bool isBlackListed, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置/取消用户黑名单

setConversationDraft(Conversation conversation, String draft) → Future<void>

保存草稿

setConversationSilent(Conversation conversation, bool isSilent, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置/取消会话免到扰

setConversationTimestamp(Conversation conversation, int timestamp) → Future<void>

设置会话时间戳

setConversationTop(Conversation conversation, bool isTop, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置/取消会话置顶

setFavGroup(String groupId, bool isFav, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置/取消收藏群组

setFavUser(String userId, bool isFav, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置收藏用户

setFriendAlias(String friendId, String alias, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置好友备注名

setGlobalSlient(bool isSilent, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置/取消全局静音

setGroupManager(String groupId, bool isSet, List<String> memberIds, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

设置/取消群管理员

setHiddenGroupMemberName(bool isHidden, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置是否群组隐藏用户名

setHiddenNotificationDetail(bool isHidden, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置推送隐藏详情

setMediaMessagePlayed(int messageId) → Future<void>

设置消息已经播放

setNoDisturbingTimes(int startMins, int endMins, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置免打扰时间段

setUserEnableReceipt(bool isEnable, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置当前用户是否启用回执功能，仅当服务支持回执功能有效

setUserSetting(int scope, String key, String value, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback) → Future<void>

设置用户设置

startLog() → void

开启协议栈日志

stopLog() → void

结束协议栈日志

transferGroup(String groupId, String newOwner, OperationSuccessVoidCallback successCallback, OperationFailureCallback errorCallback, {List<int> notifyLines = const [], MessageContent? notifyContent}) → Future<void>

转移群组

updateMessage(int messageId, MessageContent content) → Future<void>

更新消息内容

updateMessageStatus(int messageId, MessageStatus status) → Future<void>

更新消息状态

uploadMedia(String fileName, Uint8List mediaData, int mediaType, OperationSuccessStringCallback successCallback, SendMediaMessageProgressCallback progressCallback, OperationFailureCallback errorCallback) → Future<void>

上传媒体数据