SDK 介绍

网易云信即时通讯 SDK（NetEase Instant Messaging SDK，简称 NIM SDK）为 HarmonyOS 项目提供完善的即时通信功能开发能力。NIM HarmonyOS SDK 屏蔽其内部复杂细节，对外提供较为简洁的 API，方便您快速集成即时通信功能。

• nim/sdk 接口类包含登录、用户、好友、会话、消息等模块调用的所有方法。
• chatroom/sdk 接口类包含聊天室模块调用的所有方法。

API 调用方式

集成 NIM SDK 后，所有 SDK 能力均通过 NIM SDK 实例提供的 service 进行调用，例如：

• 通过 loginService 进行登录：

const nim: NIMInterface = NIMSdk.newInstance(context, initializeOptions, serviceOptions)

nim.loginService.on('onLoginStatus', loginStatus => {
    console.log('收到 V2NIMLoginService 模块的 onLoginStatus 事件', loginStatus);
})
await nim.loginService.login("YOUR_ACCOUNT", "YOUR_TOKEN")
Copy

• 通过 messageService 进行消息发送：

const message = nim.messageCreator.createTextMessage("hello")
await nim.messageService?.sendMessage(message, 'YOUR_ACCOUNT|1|RECEIVER_ACCOUNT')
Copy

错误码

在调用 API 的过程中，SDK 可能会返回错误码或状态码，您可以根据 错误码或状态码 判断当前 SDK 或任务的状态。如果遇到未知的错误码，请 提交工单 联系网易云信技术支持工程师排查。

API 概览

V2NIMInterface：NIMSDK 对外提供的服务接口，需要在登录后才有效。

interface V2NIMInterface {
    clientAntispamUtil: V2NIMAntispamService;
    conversationGroupService: V2NIMConversationGroupService;
    conversationIdUtil: V2NIMConversationIdUtil;
    conversationService: V2NIMConversationService;
    friendService: V2NIMFriendService;
    httpService: V2NIMHttpServiceInternal;
    localConversationService: V2NIMLocalConversationService;
    logger: Logger;
    loginService: V2NIMLoginService;
    messageCreator: V2NIMMessageCreator;
    messageService: V2NIMMessageService;
    notificationService: V2NIMNotificationService;
    pushService: V2NIMPushService;
    settingService: V2NIMSettingService;
    signallingService: V2NIMSignallingService;
    storageService: V2NIMStorageService;
    storageUtil: V2NIMStorageUtil;
    teamService: V2NIMTeamService;
    userService: V2NIMUserService;
    destroy(): Promise<void>;
    updateOptions(options: NIMInitializeOptions): void;
}
Copy

服务接口类	描述
V2NIMLoginService	提供登录、登出、踢出其他设备端、注册登录连接状态监听器等接口。
V2NIMConversationService	提供创建、删除、更新、获取会话，会话未读数、置顶会话、注册会话监听等接口。
V2NIMLocalConversationService	提供创建、删除、更新、获取、置顶本地会话，本地会话消息未读数相关、注册本地会话监听等接口。
V2NIMConversationGroupService	提供创建、删除、更新、获取会话分组，注册会话分组监听等接口。
V2NIMMessageCreator	提供消息构建接口，支持构建多种类型的消息。
V2NIMMessageService	提供消息操作接口，包括发送、回复、转发、删除、更新、获取消息，注册消息监听，以及 PIN 消息、快捷评论、收藏等进阶操作接口。
V2NIMUserService	提供用户资料相关接口，包括注册用户资料监听，获取、更新用户资料，拉黑用户等接口。
V2NIMFriendService	提供好友关系相关接口，包括注册好友关系监听，添加、删除好友，接受、 拒绝好友申请，获取、设置好友信息等接口。
V2NIMNotificationService	提供自定义通知相关接口，包括注册自定义通知监听，发送自定义通知接口。
V2NIMPushService	提供第三方推送相关接口，包括注册监听，开启、关闭第三方推送服务接口。
V2NIMSettingService	提供系统设置相关接口，包括设置单聊/群聊消息免打扰模式、获取单聊/群聊消息免打扰模式、获取单聊消息免打扰列表、获取会话消息的免打扰状态等接口。
V2NIMStorageService	提供存储服务相关接口，包括上传、下载文件，添加自定义存储场景等接口。
V2NIMTeamService	提供群组相关接口，包括注册群组监听，创建、修改、退出、解散、加入群组、获取群组相关信息等接口。
V2NIMSignallingService	提供信令服务相关接口，呼叫邀请、频道管理、用户管理、离线消息同步、多端同步以及自定义控制信令等接口。
V2SyncServiceInterface	提供数据同步相关接口。
V2NIMChatroomClient	提供群组相关接口，包括注册/注销聊天室实例监听，创建、进入、退出、销毁聊天室等接口。
V2NIMChatroomMessageCreator	提供聊天室消息构建接口，支持构建多种类型的聊天室消息。
V2NIMChatroomQueueService	提供聊天室队列服务相关接口，包括初始化、新增、更新、清空队列等接口。
V2NIMChatroomService	提供聊天室服务接口，包括注册/注销聊天室监听器、收发聊天室消息、管理聊天室成员、维护聊天室信息等。
V2NIMChatroomStorageService	提供聊天室存储服务相关接口，包括上传、下载文件等接口。