OpenIMAdapter class
OpenIM → SyIm 适配层(唯一实时路径)。真实调用 OpenIM.iMManager。
不再存在 sy_im_flutter_sdk 原生 MethodChannel 壳;原生通道仅来自 flutter_openim_sdk。
OpenIM API / channel 缺失时抛 UnimplementedError。
Constructors
- OpenIMAdapter({required String imApiAddr, required String imWsAddr})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- imApiAddr ↔ String
-
OpenIM API,例如
http://127.0.0.1:10002getter/setter pair - imWsAddr ↔ String
-
OpenIM WebSocket,例如
ws://127.0.0.1:10001getter/setter pair - isInited → bool
-
no setter
- lastGroupReadSeq ↔ int
-
getGroupMessageReadInfo 最近一次查到的消息 seq(没查到为 -1),供控制面 who-read 使用。
getter/setter pair
- onConnectFailed ↔ void Function(int? code, String? error)?
-
getter/setter pair
- onConnecting ↔ void Function()?
-
getter/setter pair
- onConnectSuccess ↔ void Function()?
-
getter/setter pair
-
onConversationsChanged
↔ void Function(List<
SyImConversation> conversations)? -
getter/setter pair
- onConversationUpdated ↔ void Function()?
-
getter/setter pair
- onKickedOffline ↔ void Function()?
-
getter/setter pair
- onMessageRevoked ↔ void Function(SyImRevokedMessage info)?
-
getter/setter pair
-
onRecvC2CReadReceipt
↔ void Function(List<
SyImReadReceipt> receipts)? -
getter/setter pair
- onRecvNewMessage ↔ void Function(String msgId, String fromUserId, String? groupId, String? text)?
-
getter/setter pair
- onTotalUnreadChanged ↔ void Function(int totalUnread)?
-
getter/setter pair
- onTypingChanged ↔ void Function(SyImTypingStatus status)?
-
getter/setter pair
- onUserTokenExpired ↔ void Function()?
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
acceptFriendApplication(
{required String userId, String handleMsg = ''}) → Future< void> -
addFriend(
{required String userId, String reason = ''}) → Future< void> - 发起好友申请(对方需同意)。
-
addToBlacklist(
{required String userId}) → Future< void> -
createGroup(
{required String groupName, String groupId = '', List< String> memberUserIds = const []}) → Future<SyImGroup> -
创建工作群。
groupId为空时由 OpenIM 分配。 -
dismissGroup(
{required String groupId}) → Future< void> -
getBlacklist(
) → Future< List< SyImBlacklistUser> > -
getConversations(
) → Future< List< SyImConversation> > -
getFriendApplications(
{bool sentByMe = false}) → Future< List< SyImFriendApplication> > -
收到的好友申请。
sentByMe为 true 时返回自己发出的申请。 -
getFriends(
) → Future< List< SyImFriend> > -
getGroupMembers(
{required String groupId, int count = 100}) → Future< List< SyImGroupMember> > -
getGroupMessageReadInfo(
{required String conversationId, required String clientMsgId}) → Future< SyImGroupReadInfo> -
getJoinedGroups(
) → Future< List< SyImGroup> > -
getSelfProfile(
) → Future< SyImUserProfile> -
getTotalUnreadCount(
) → Future< int> - 全部会话未读总数。
-
getUserProfiles(
List< String> userIds) → Future<List< SyImUserProfile> > -
initSdk(
{required String dataDir, int? platformID}) → Future< void> - SyIm.create / init → OpenIM.iMManager.initSDK
-
inviteToGroup(
{required String groupId, required List< String> userIds, String reason = ''}) → Future<void> -
joinGroup(
{required String groupId, String reason = ''}) → Future< void> -
kickGroupMembers(
{required String groupId, required List< String> userIds, String reason = ''}) → Future<void> -
login(
{required String userId, required String token}) → Future< void> - SyImEngine.login → OpenIM.iMManager.login
-
logout(
) → Future< void> - SyImEngine.logout → OpenIM.iMManager.logout
-
markConversationAsRead(
{required String conversationId}) → Future< void> - 将会话标为已读,并触发单聊已读回执。群会话只清未读。
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pinConversation(
{required String conversationId, required bool pinned}) → Future< void> -
quitGroup(
{required String groupId}) → Future< void> -
refuseFriendApplication(
{required String userId, String handleMsg = ''}) → Future< void> -
removeFromBlacklist(
{required String userId}) → Future< void> -
revokeMessage(
{required String conversationId, required String clientMsgId}) → Future< void> -
searchMessages(
{String? conversationId, required String keyword, int count = 20}) → Future< List< SyImSearchHit> > -
sendAtTextMessage(
{required String groupId, required String text, required List< String> atUserIds, Map<String, String> atNicknames = const {}}) → Future<String> -
sendCustomMessage(
{String? toUserId, String? groupId, required String data, String customExtension = '', String description = ''}) → Future< String> -
sendTextMessage(
{String? toUserId, String? groupId, required String text}) → Future< String> - createTextMessage + sendMessage
-
setConversationDoNotDisturb(
{required String conversationId, required int status}) → Future< void> -
setConversationDraft(
{required String conversationId, required String draft}) → Future< void> -
setGroupCustomInfo(
{required String groupId, String? groupName, String? notification, String? ex}) → Future< void> -
setGroupMemberCustomInfo(
{required String groupId, required String userId, String? nickname, String? ex}) → Future< void> -
setSelfProfile(
{String? nickname, String? faceUrl, String? ex}) → Future< void> -
setTyping(
{required String conversationId, required bool typing}) → Future< void> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited