IM 即时通讯
Flutter
新手接入指南
产品介绍
简介
主要功能
产品优势
接口及业务限制
功能介绍
帐号集成与登录
基础消息功能
群组功能
聊天室功能
聊天室标签功能
圈组功能
多端登录与互踢策略
质量数据监控台
更新日志
IM UIKit 更新日志
NIM SDK 更新日志
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能列表
快速集成 IM UIKit
组件导入
初始化
界面跳转
全局配置
语言设置
会话列表相关
集成会话列表界面
事件监听
自定义会话列表界面 UI
会话消息相关
集成会话界面
事件监听
发送自定义消息
自定义会话界面 UI
通讯录相关
集成通讯录界面
事件监听
自定义通讯录界面 UI
不含 UI 集成
集成 SDK
初始化
登录登出
消息收发
最近会话
用户资料
用户关系
在线状态订阅
历史消息
系统通知
群组功能
超大群
Android 离线推送与消息提醒
APNs 离线推送
反垃圾
开通聊天室功能
聊天室
圈组功能
已知问题
圈组登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
频道未读数管理
搜索服务器与频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
用户定制权限
身份组相关查询
成员权限查询与判定
圈组消息相关
图解圈组消息流转
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
查询历史消息
会话消息回复(Thread)
圈组快捷评论
圈组消息缓存
获取频道最后一条消息
圈组消息搜索
圈组订阅机制
圈组离线推送
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组内容审核
圈组相关抄送
圈组第三方回调
聊天扩展
其他
服务端会话服务
API 参考
Flutter API 参考
错误码和警告码
IM 控制台指南
创建应用
升级服务
注册 IM 账号
服务协议

API 参考

更新时间: 2022/11/03 21:05:04

网易云信 IM 即时通讯服务基于网易多年的通信服务技术积累,致力于打造最稳定的即时通讯平台。IM Flutter SDK为 Flutter 应用提供完善的即时通信功能开发框架,屏蔽其内部复杂细节,对外提供较为简洁的 API 接口,方便第三方应用快速集成即时通信功能。NIM Flutter SDK 目前支持 Android、iOS 、Web、Windows 和 macOS 平台。

以下为 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

此文档是否对你有帮助?
有帮助
我要吐槽
  • NimCore
  • AuthService
  • UserService
  • MessageService
  • TeamService
  • ChatroomService
  • EventSubscribeService
  • SystemMessageService
  • NOSService
  • AudioService
  • SettingsService
  • PassThroughService
  • QChatService
  • QChatServerService
  • QChatChannelService
  • QChatRoleService
  • QChatMessageService