快速开始
从初始化到第一条消息，一气呵成
初始化 → 连接 → 订阅频道 → 发送消息。查看 JavaScript、iOS 代码示例，以及各平台的接入准备说明。
只需一行 npm install ncloudchat 即可安装，并附带 TypeScript 类型定义。
quickstart.js
// npm install ncloudchat
import { Chat } from "ncloudchat";
// 1. 使用项目 ID 初始化
const nc = new Chat();
nc.initialize("YOUR_PROJECT_ID");
// 2. 以用户身份连接
await nc.connect({ id: "user-001", name: "Aria" });
// 3. 创建并订阅频道
const channel = await nc.createChannel({
type: "PUBLIC",
name: "general",
});
await nc.subscribe(channel.id);
// 4. 绑定消息接收事件
nc.bind("onMessageReceived", (channelId, message) => {
console.log(channelId, message);
});
// 5. 发送第一条消息
await nc.sendMessage(channel.id, {
type: "text",
message: "你好，sendstage！",
});
Android、Unity、Unreal、React Native 的接入准备，也请在各标签页中查看。
开始使用
只需三步
无需复杂的基础设施配置，从创建项目到发送第一条消息。
- 1在 dash.ncloudchat.com 免费注册并创建项目，即可获得项目 ID。
- 2安装 SDK，使用项目 ID 初始化，然后以用户 ID 连接。
- 3创建并订阅频道，然后发送第一条消息。可在管理后台中立即查看。
开发体验
专为开发者设计的 SDK
从类型、事件到重连，聊天开发中繁琐的部分都由 SDK 代劳。
提供 TypeScript 类型
ncloudchat 包内置类型定义，可直接使用自动补全和类型检查。
事件驱动架构
通过绑定 onMessageReceived、onMemberJoined 等事件，实时处理消息接收以及加入、退出、封禁。
自动重连
网络断开时，Socket 会自动尝试重新连接，并可通过重连事件跟踪连接状态。
REST API
无需客户端 SDK，服务器即可通过 API 调用发送消息、管理频道和用户。
支持环境
随处可用的同一套聊天
从网页浏览器到移动应用、游戏引擎，全部连接到同一个后端。
JavaScript
- Chrome 16+ · Edge 13+ · Safari 7+
- Firefox 11+ · Opera 12.1+
- iOS Safari 7+ · Android 浏览器 4.4+
iOS
- iOS 13.0 及以上
- Swift 5 及以上 · Xcode 13 及以上
- 支持通过 Swift Package Manager 安装
Android
- 提供适用于 Android 应用（Kotlin）的 SDK
- 可与 UI Kit 搭配使用
Unity
- 提供适用于 Unity 游戏客户端的 SDK
- 游戏聊天可同时使用 Express Message 高速通道
Unreal (C++)
- 确认所使用的 Unreal Engine 版本和目标平台。
- 准备项目 ID 和玩家认证方式。
React Native
- 确认 React Native 版本以及 iOS、Android 目标环境。
- 准备项目 ID 和用户认证方式。