NIM Web SDK

完整的 NIM SDK 由 NIMInterface, ChatroomServiceInterface 组成。

• NIMInterface 是 NIM SDK 的入口，负责建立长连接，登录，断开长连接，销毁实例、多端互踢等功能。
• EventServiceInterface 挂载了订阅发布事件相关的能力，如订阅，发布事件等
• FriendServiceInterface 挂载了好友相关的 API，如获取，添加，申请，删除好友等
• PassThroughServiceInterface 挂载了透传协议
• MsgExtendServiceInterface 挂载了消息扩展相关的 API，如 thread消息
• MsgServiceInterface 挂载了消息相关的 API，如发送消息，发送文件消息，撤回，已读等
• MsgLogServiceInterface 挂载了消息管理相关的 API，如删除漫游消息等
• SessionServiceInterface 挂载了会话相关的 API，如查看会话，重置会话等
• SystemMessageServiceInterface 挂载了系统消息相关的 API，如发送自定义系统通知
• TeamServiceInterface 挂载了群相关的 API，如获取，创建，离开群，群成员管理。
• UserServiceInterface 挂载了用户及关系相关的 API，如黑名单，静音列表，我的名片

它的调用形式如

const nim = new NIM({
  // ...初始化配置信息
  appkey: 'YOUR_APPKEY',
  account: 'YOUR_ACCID',
  token: 'YOUR_TOKEN',
  debugLevel: 'debug',
})


// 初始化事件监听
const eventList = [
  // 登陆完成事件
  'logined',

  // 收到多端登陆通知触发事件
  'multiPortLogin',

  // 被踢
  'kicked',

  // 即将开始重连
  'willReconnect',

  // 断开连接
  'disconnect',

  // 收到消息
  'msg',
]

eventList.forEach((key: any) => {
  nim.on(key, (res) => {
    console.log(`收到 ${key} 事件：`, res ? JSON.parse(JSON.stringify(res)) : res);
  });
})

// 连接并且登陆后，会收到 logined 事件
await nim.connect()

await nim.msg.sendTextMsg()

NIMInterface 对象

初始化参数见 NIMInterface.NIMInitializeOptions

初始化事件见 NIMInterface.IMEventInterface

方法	功能描述
NIMInterface.connect	建立长连接，并且登录
NIMInterface.disconnect	断开连接。
NIMInterface.destroy	销毁实例

MsgServiceInterface

这里只例举部分 API，完整的 API 请参见 MsgServiceInterface

方法	功能描述
MsgServiceInterface.sendTextMsg	发送文本消息
MsgServiceInterface.sendTipMsg	发送提醒消息
MsgServiceInterface.sendGeoLocationMsg	发送文件消息
MsgServiceInterface.sendCustomMsg	发送文件消息
MsgServiceInterface.sendFileMsg	发送其他文件消息
MsgServiceInterface.sendImageMsg	发送图片消息
MsgServiceInterface.sendVideoMsg	发送视频消息
MsgServiceInterface.sendAudioMsg	发送音频消息
MsgServiceInterface.forwardMsg	转发消息
MsgServiceInterface.recallMsg	撤回消息
MsgServiceInterface.deleteSelfMsgs	单向删除消息
MsgServiceInterface.sendMsgReceipt	发送已读标记
MsgServiceInterface.sendTeamMsgReceipt	发送群已读标记
MsgServiceInterface.getTeamMsgReads	获取群消息已读的数量
MsgServiceInterface.getTeamMsgReadAccounts	获取群消息已读的账号

MsgLogServiceInterface

这里只例举部分 API，完整的 API 请参见 MsgLogServiceInterface

方法	功能描述
MsgLogServiceInterface.deleteRoamingMsgs	批量删除服务器上某些会话的漫游消息

EventServiceInterface

这里只例举部分 API，完整的 API 请参见 EventServiceInterface

方法	功能描述
EventServiceInterface.publishEvent	发布某事件
EventServiceInterface.subscribeEvent	订阅某事件
EventServiceInterface.unSubscribeEvents	取消订阅
EventServiceInterface.querySubscribeEvents	查询所订阅的事件

FriendServiceInterface

这里只例举部分 API，完整的 API 请参见 FriendServiceInterface

方法	功能描述
FriendServiceInterface.getFriends	获取好友列表
FriendServiceInterface.addFriend	直接加为好友
FriendServiceInterface.applyFriend	申请加为好友
FriendServiceInterface.deleteFriend	删除好友
FriendServiceInterface.updateFriend	更新好友

PassThroughServiceInterface

这里只例举部分 API，完整的 API 请参见 PassThroughServiceInterface

方法	功能描述
PassThroughServiceInterface.request	透传协议

MsgExtendServiceInterface

这里只例举部分 API，完整的 API 请参见 MsgExtendServiceInterface

方法	功能描述
MsgExtendServiceInterface.getThreadMsgs	获取 thread 消息列表
MsgExtendServiceInterface.getMsgsByIdServer	获取 thread 历史消息

SessionServiceInterface

这里只例举部分 API，完整的 API 请参见 SessionServiceInterface

方法	功能描述
SessionServiceInterface.getSession	获取会话
SessionServiceInterface.getSessions	获取会话列表
SessionServiceInterface.resetSessionUnreadCount	重置某个会话的未读数
SessionServiceInterface.resetAllSessionsUnreadCount	重置所有会话的未读数
SessionServiceInterface.deleteSession	删除指定的会话
SessionServiceInterface.deleteAllSessionsFromLocal	删除所有本地的会话

SystemMessageServiceInterface

这里只例举部分 API，完整的 API 请参见 SystemMessageServiceInterface

方法	功能描述
SystemMessageServiceInterface.sendCustomSysMsg	发送自定义系统通知

TeamServiceInterface

这里只例举部分 API，完整的 API 请参见 TeamServiceInterface

方法	功能描述
TeamServiceInterface.getTeamInfo	获取群信息
TeamServiceInterface.getTeams	获取群列表
TeamServiceInterface.createTeam	创建群
TeamServiceInterface.dismissTeam	解散群，群主可操作
TeamServiceInterface.leaveTeam	主动退群
TeamServiceInterface.transferTeam	转让群
TeamServiceInterface.updateTeamInfo	更新群
TeamServiceInterface.getTeamMembers	获取群成员
TeamServiceInterface.addTeamMembers	添加群成员
TeamServiceInterface.removeTeamMembers	踢人出群
TeamServiceInterface.applyTeam	申请入群
TeamServiceInterface.addTeamManagers	添加群管理员
TeamServiceInterface.removeTeamManagers	移除群管理员
TeamServiceInterface.updateMyMemberInfo	修改自己在群里的信息
TeamServiceInterface.updateMemberNick	修改别人的群昵称
TeamServiceInterface.muteTeam	群组全体禁言
TeamServiceInterface.passTeamApply	通过群申请
TeamServiceInterface.rejectTeamApply	拒绝群申请
TeamServiceInterface.acceptTeamInvite	接受群邀请
TeamServiceInterface.rejectTeamInvite	拒绝群邀请

UserServiceInterface

这里只例举部分 API，完整的 API 请参见 UserServiceInterface

方法	功能描述
UserServiceInterface.setBlack	加入黑名单/从黑名单移除
UserServiceInterface.setMute	加入静音列表/从静音列表移除
UserServiceInterface.getUsersNameCardFromServer	获取用户名片数组
UserServiceInterface.updateMyNameCard	更新我的名片
UserServiceInterface.getRelations	获取关系(黑名单和静音列表)
UserServiceInterface.getBlackList	获取黑名单列表
UserServiceInterface.getMuteList	获取静音列表