网易云信 IM 即时通讯服务基于网易多年的通信服务技术积累，致力于打造最稳定的即时通讯平台。IM Flutter SDK 为 Flutter 应用提供完善的即时通信功能开发框架，屏蔽其内部复杂细节，对外提供较为简洁的 API 接口，方便第三方应用快速集成即时通信功能。NIM Flutter SDK 目前支持 Android 和 iOS。非移动端（包括 Windows、macOS 和 Web）仍为 Beta 版本，处于内测阶段，敬请期待。

本文仅列出部分核心类和核心接口。全量的类和接口，请前往 IM Flutter API 参考 进行搜索查阅。

核心类

以下为 NIM Flutter SDK 的部分核心类：

• NimCore 类主要提供初始化、获取其他子服务的能力。
• AuthService 类提供鉴权接口、包括登录和注销。
• UserService 类提供用户服务接口。
• MessageService 提供消息收发接口。
• EventSubscribeService 类提供事件订阅服务接口。
• SystemMessageService 类提供系统通知服务接口。
• TeamService 类提供群聊服务接口。
• SuperTeamService 类提供超大群服务接口。
• ChatroomService 类提供聊天室服务接口。
• NOSService 类提供 NOS 服务接口。
• AudioService 类提供音频服务接口。
• SettingsService 类提供设置项相关服务接口。
• PassThroughService 类提供透传服务接口。
• QChatService 类提供圈组登录登出相关接口（目前仅支持 iOS 和 Android）。
• QChatServerService 类提供圈组服务器服务接口（目前仅支持 iOS 和 Android）。
• QChatChannelService 类提供圈组频道服务接口（目前仅支持 iOS 和 Android）。
• QChatMessageService 类提供圈组消息服务接口（目前仅支持 iOS 和 Android）。
• QChatRoleService 类提供圈组身份组服务接口（目前仅支持 iOS 和 Android）。
• SettingsService 类提供 SDK 设置类接口，如开启/关闭推送和免打扰等。

在调用 API 过程中，SDK 可能会返回错误码和警告码，请参考 错误码和警告码。

NimCore

方法/属性	功能	起始版本
instance	获取全局 SDK 对象。	V1.0.0
initialize	初始化 SDK	V1.0.0
authService	获取鉴权服务对象	V1.0.0
userService	获取用户服务对象	V1.0.0
messageService	获取消息服务对象	V1.0.0
eventSubscribeService	获取事件订阅服务对象	V1.0.0
chatroomService	获取聊天室服务对象	V1.0.0
audioService	获取音频服务对象	V1.0.0
teamService	获取群聊服务对象	V1.0.0
systemMessageService	获取系统消息服务对象	V1.0.0
settingsService	获取设置服务对象	V1.0.0
nosService	获取 NOS 服务对象	V1.0.0
passThroughService	获取透传服务对象	V1.0.0

AuthService

方法/属性	功能	起始版本
login	账号登录	V1.0.0
logout	账号注销	V1.0.0
kickOutOtherOnlineClient	踢掉其他端	V1.0.0
authStatus	登录状态事件流	V1.0.0
onlineClients	多端登录事件流	V1.0.0
dynamicTokenProvider	设置动态登录 token 提供者	V1.0.0

UserService

方法/属性	功能	起始版本
addFriend	添加好友	V1.0.0
deleteFriend	删除好友	V1.0.0
getFriendList	获取好友列表	V1.0.0
updateMyUserInfo	更新个人资料	V1.0.0

MessageService

方法/属性	功能	起始版本
sendMessage	发送消息	V1.0.0
searchMessage	查询消息	V1.0.0
replyMessage	回复消息	V1.0.0
revokeMessage	撤回消息	V1.0.0
pullMessageHistory	拉取消息历史	V1.0.0
onMessage	接收消息事件流	V1.0.0
onMessageStatus	消息状态变化事件流	V1.0.0

TeamService

方法/属性	功能	起始版本
createTeam	创建群聊	V1.0.0
dismissTeam	解散群聊	V1.0.0
queryTeam	查询群资料	V1.0.0
applyJoinTeam	申请加入群聊	V1.0.0
acceptInvite	接受入群邀请	V1.0.0
quitTeam	退出群聊	V1.0.0
passApply	通过入群申请	V1.0.0
removeMembers	从群聊移除用户	V1.0.0

ChatroomService

方法/属性	功能	起始版本
enterChatroom	加入聊天室	V1.0.0
exitChatroom	退出聊天室	V1.0.0
fetchChatroomInfo	获取聊天室信息	V1.0.0
fetchChatroomMembers	获取聊天室成员	V1.0.0
fetchMessageHistory	获取聊天室历史消息	V1.0.0
sendChatroomMessage	发送聊天室消息	V1.0.0
onMessageReceived	接收聊天室消息事件流	V1.0.0

EventSubscribeService

方法/属性	功能	起始版本
registerEventSubscribe	订阅指定账号的在线状态事件	V1.0.0
unregisterEventSubscribe	取消订阅指定账号的在线状态事件	V1.0.0
publishEvent	向订阅者发布事件	V1.0.0
eventSubscribeStream	接收到订阅事件流	V1.0.0

SystemMessageService

方法/属性	功能	起始版本
querySystemMessageUnread	获取未读系统通知消息	V1.0.0
clearSystemMessages	删除所有系统通知	V1.0.0
sendCustomNotification	发送自定义系统通知	V1.0.0
onCustomNotification	接收到系统通知消息	V1.0.0

NOSService

方法/属性	功能	起始版本
upload	上传附件	V1.0.0
onNOSTransferProgress	进度事件流	V1.0.0
onNOSTransferStatus	状态事件流	V1.0.0

AudioService

方法/属性	功能	起始版本
startRecord	开始音频录制	V1.0.0
stopRecord	停止音频录制	V1.0.0
onAudioRecordStatus	录制状态事件流	V1.0.0

SettingsService

方法/属性	功能	起始版本
enableNotificationAndroid	配置消息提醒（Android）	V1.0.0
enablePushServiceAndroid	开启或关闭消息推送（Android）	V1.0.0
updateAPNSToken	更新 iOS deviceToken	V1.0.0
uploadLogs	日志上传	V1.0.0

更多 SettingsService 包含的方法，请参考 SettingsService。

PassThroughService

方法/属性	功能	起始版本
httpProxy	发送 HTTP 代理请求	V1.0.0

QChatService

方法/属性	功能	起始版本
kickOtherClients	踢掉多端同时圈组在线的其他端	V9.3.0
login	登录圈组	V9.3.0
logout	登出圈组	V9.3.0

QChatServerService

方法/属性	功能	起始版本
createServer	创建圈组的服务器	V9.3.0
deleteServer	删除服务器	V9.3.0
updateServer	修改服务器	V9.3.0
getServersByPage	分页查询服务器	V9.3.0
applyServerJoin	申请加入服务器	V9.3.0
acceptServerApply	接受其他用户加入服务器的申请	V9.3.0
inviteServerMembers	邀请其他用户加入服务器	V9.3.0
acceptServerInvite	接受其他用户发出的加入服务器邀请	V9.3.0
generateInviteCode	生成邀请码	V9.3.0
joinByInviteCode	通过邀请码加入服务器	V9.3.0

更多相关方法，请参考 QChatServerService。

QChatChannelService

方法/属性	功能	起始版本
createChannel	创建频道	V9.3.0
updateChannel	更细频道	V9.3.0
deleteChannel	删除频道	V9.3.0
getChannelByPage	分页查询频道列表	V9.3.0

更多相关方法，请参考 QChatChannelService。

QChatRoleService

方法/属性	功能	起始版本
createServerRole	创建服务器身份组	V9.3.0
updateServerRole	修改服务器身份组	V9.3.0
deleteServerRole	删除服务器身份组	V9.3.0
getServerRoles	查询服务器身份组列表	V9.3.0
addChannelRole	创建频道身份组	V9.3.0
updateChannelRole	修改频道身份组	V9.3.0
getChannelRoles	查询频道身份组	V9.3.0

更多相关方法，请参考 QChatRoleService。

QChatMessageService

方法/属性	功能	起始版本
sendMessage	在频道在发送消息	V9.3.0
deleteMessage	删除消息	V9.3.0
updateMessage	更新消息	V9.3.0
revokeMessage	撤回消息	V9.3.0
getMessageHistory	查询历史消息	V9.3.0
markMessagRead	标记圈组的某条消息为已读	V9.3.0
markSystemNotificationsRead	标记圈组的系统通知为已读	V9.3.0
resendMessage	重发消息	V9.3.0
sendSystemNotification	发送自定义系统通知	V9.3.0

更多相关方法，请参考 QChatMessageService。