快速入門
從初始化到第一則訊息，一次完成
初始化 → 連線 → 訂閱頻道 → 傳送訊息。查看 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 呼叫傳送訊息、管理頻道與使用者。
支援環境
在哪裡都是同樣的聊天
從網頁瀏覽器到行動 App、遊戲引擎，全都連接到同一個後端。
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 App（Kotlin）專用 SDK
- 可搭配 UI Kit 使用
Unity
- 提供 Unity 遊戲用戶端專用 SDK
- 遊戲聊天可同時使用 Express Message 高速路徑
Unreal (C++)
- 確認使用中的 Unreal Engine 版本與目標平台。
- 準備專案 ID 與玩家驗證方式。
React Native
- 確認 React Native 版本與 iOS、Android 目標環境。
- 準備專案 ID 與使用者驗證方式。