uchatの使い方

チャットルームの作成・設置・運営・機能追加の方法をまとめました。

はじめに

  • uchatで何が作れるか →

    自分のサイトに設置したuchatのチャットルームに機能を追加する3つの方法と、どの用途にどの方法を選べばよいかを説明します。

  • 5分で設置 →

    チャットルームを作成し、設置コードを貼り付けて自分のサイトにチャットルームを表示します。フレームワーク・CMS・チャンネルのチャットルームへの設置と、表示されないときの確認点も扱います。

  • はじめてのスクリプト →

    ページスクリプトでチャットルームの入室イベントを受け取り、案内行を表示し、メッセージを送ってみます。

ガイド

  • 会員連携 →

    自分のサイトにログインした会員を、ニックネーム・ID・レベル・権限のままチャットルームに入室させる流れと、入室できないときの確認点を説明します。

  • 非同期読み込みと複数のチャットルーム →

    uchat.jsが読み込まれる前にイベントを登録する方法、1ページの複数のチャットルームにイベントを分けて登録する方法、SPAでチャットルームを設置・後片付けする方法、右下のフローティングウィジェットを設置する方法を説明します。

  • スキンUIを拡張する →

    基本スキンにメニューボタンを追加し、ダイアログで入力を受け取り、会話の上に領域を設置し、解除関数で後片付けする流れを1つの例で追っていきます。

  • リアルタイムデータの送受信 →

    チャンネル(room.plugin)を使って同じチャットルームの参加者どうしでチャットメッセージ以外のデータをやり取りし、受け取ったデータを検証する流れを説明します。

  • サーバーからチャットルームに通知を送る →

    自分のサーバーからサーバーAPI(v2)でチャットルームのチャンネルにデータを送り、ページスクリプトやプラグインでサーバーが送ったものだけを選んで表示する流れを説明します。

  • セキュリティチェックリスト →

    uchatを組み込んだサイトを公開する前に、トークン、会員連携の署名、チャンネルデータ、サーバーAPI、画面出力で確認すべき項目をまとめています。

リファレンス

  • u-chat の属性 →

    チャットルームを埋め込むu-chatタグの属性と、設置・削除のルールです。

  • U.chat() と room オブジェクト →

    ページスクリプトの入り口であるU.chat() と、イベントコールバックが受け取るroomオブジェクトの値・関数の一覧です。

  • イベント →

    チャットルームのイベント名、受け取る値、beforeでfalseを返したときに実際に止まる処理をまとめた一覧です。

  • スキンUI API →

    基本スキン(basic-v2)にメニュー・ダイアログ・領域・装飾を追加するroom.skin APIの全一覧です。

  • チャンネルAPIと上限 →

    room.pluginチャンネルでリアルタイムにデータをやり取りする関数、値の形式、保存と送信の上限をまとめた正式なリファレンスです。

  • サーバーREST API →

    自分のサーバーからチャットルームの状態を取得し、プラグインチャンネルにデータを送るREST API(v2)の認証、エンドポイント、レスポンス、エラーコードと、以前のv1方式です。

  • 会員連携の署名仕様 →

    会員連携のuser_data文字列のフィールド、署名(hash)の作り方、時刻連携のチェック、検証用の固定値です。

  • レガシースキンAPI →

    古いチャットルームが使うレガシースキン(basic)のroom.skin API — jQuery DOM、メニューバー、ポップアップ、ニックネームメニュー — の一覧と、基本スキンへの移行対応表です。

サンプル

  • YouTubeを一緒に見る →

    モデレーター以上が選んだYouTube動画を、チャットルームの全員で一緒に見るサンプルです。

  • じゃんけん →

    ニックネームメニューからほかの人にじゃんけんを申し込み、双方が送った値を確認して結果を知らせるサンプルです。

  • ニックネームとメッセージの装飾 →

    基本スキンで、ニックネームの色・画像、メッセージの背景・行間、ニックネームの非表示を変えるサンプルです。

  • 決済完了の通知 →

    自分のサーバーで決済が終わったらサーバーREST API(v2)でチャットルームに知らせ、ページスクリプトが受け取ってチャット画面に表示するサンプルです。

管理

  • 管理機能の概要 →

    管理ページのメニューと、チャットルーム内で使う管理コマンドを、開発者の視点で簡単にまとめます。

商号 UCHAT · 代表者 김경욱 · 事業者登録番号 141-05-32832
所在地 경기도 파주시 와석순환로 61 · 通信販売業届出番号 2013-경기파주-4485호
代表電話 010-8677-8633 · メール support@uchat.io

ⓒ 2013–2026 UCHAT. All rights reserved.