クイックスタート
初期化から最初のメッセージまで、ひと続きで
初期化 → 接続 → チャンネル購読 → メッセージ送信。JavaScript・iOSのコード例と、各プラットフォームの連携準備ガイドをご確認ください。
npm install ncloudchat の1行でインストールできます。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の連携準備も、各タブでご確認ください。
はじめに
3ステップで十分です
複雑なインフラ設定なしで、プロジェクト作成から最初のメッセージまで。
- 1dash.ncloudchat.com で無料登録してプロジェクトを作成すると、プロジェクトIDが発行されます。
- 2SDKをインストールしてプロジェクトIDで初期化し、ユーザーIDで接続します。
- 3チャンネルを作成・購読して、最初のメッセージを送信します。ダッシュボードですぐに確認できます。
開発体験
開発者のために設計されたSDK
型、イベント、再接続まで。チャット開発の手間がかかる部分はSDKが引き受けます。
TypeScriptの型を提供
ncloudchatパッケージに型定義が組み込まれているため、自動補完と型チェックをすぐに使えます。
イベント駆動アーキテクチャ
onMessageReceived、onMemberJoined などのイベントをバインドして、メッセージ受信や入室・退室・ブロックをリアルタイムに処理します。
自動再接続
ネットワークが切断されてもソケットが自動で再接続を試み、再接続イベントで接続状態を追跡できます。
REST API
クライアントSDKがなくても、サーバーからAPI呼び出しでメッセージ送信やチャンネル・ユーザーの管理を行えます。
対応環境
どこでも同じチャットを
Webブラウザからモバイルアプリ、ゲームエンジンまで、ひとつのバックエンドにつながります。
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とユーザー認証方式を準備します。