GS2-Chat API リファレンス

テキストベースのチャット機能

テキストベースのチャット機能を提供します。

メッセージデータはルームごとに管理され、ネームスペース設定で設定した期間(1日〜30日)分のログが保持されます。
ルームにはパスワードを設定でき、設定した場合はメッセージの取得や投稿リクエストにパスワードが必要となります。
ルームにはユーザーIDのホワイトリストを設定でき、設定した場合はホワイトリストに含まれるゲームプレイヤーにしかメッセージの取得や投稿ができなくなります。

メッセージにはカテゴリを設定でき、クライアント側でペイロードのパース方法を切り替えることができます。
たとえば、 カテゴリ0 はテキストがペイロードにそのまま含まれる、カテゴリ1 はペイロードにスタンプのIDが含まれる、といった使い方ができます。

ルームを購読すれば、ルームに対して新しい投稿があったときにサーバからプッシュ通知を受け取ることができます。
このとき、通知を受けたいカテゴリを設定できますので、メッセージの種類や重要度別にカテゴリを分ければ、ゲームプレイヤーが通知を受け取るメッセージの種類を設定できるようになり、ユーザー体験を向上させることができます。
また、購読の設定には モバイルプッシュ通知に転送するか という設定もありますので、うまく活用してください。


GS2-Chat SDK for Game Engine API リファレンス

ゲームエンジン向け GS2-Chat SDK の モデルの仕様 と API のリファレンス

GS2-Chat SDK API リファレンス

各種プログラミング言語向け GS2-Chat SDK の モデルの仕様 と API のリファレンス

GS2-Chat スクリプト トリガー リファレンス

拡張スクリプトを呼び出すイベントトリガーのリファレンス

GS2-Chat Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例

GS2-Chat マスターデータリファレンス

マスターデータのフォーマットと インポートする各種モデルのリファレンス