チャットサーバー接続¶
Hive SDKのチャット機能は、Hive チャットソケットサーバーとのWebSocket通信を使用しています。したがって、Hive SDKのチャット機能を使用するには、まず以下のガイドを参照してHive チャットソケットサーバーに接続する必要があります。
接続要求¶
チャットに接続するには、Chat
クラスのconnect
メソッドを呼び出します。この時、追加情報を提供するためにextraData
引数として文字列値を渡すことができます。例えば、アプリのデータベースで管理されているアプリユーザーのニックネーム文字列を追加情報として渡すと、チャットウィンドウでのチャットニックネームとして使用したり、「~が入室しました。」のような入室イベントメッセージを実装する際に使用できます。
以下はチャット接続を要求する例のコードです。
Warning
Hive SDKのチャット機能は、Hive SDKの認証機能を使用してログインしたユーザー(ゲストアカウントを含む)のみが使用でき、PlayerID
が発行されています。
切断要求¶
チャットを切断するには、Chatクラスのdisconnect()
メソッドを呼び出します。以下はチャットを切断するための例コードです。
Note
アプリのユーザーアカウントがログアウトすると、チャット切断リクエストが自動的に実行されます。
接続ステータスの確認¶
アプリのユーザーが現在チャットに接続されているかどうかを確認します。ChatクラスのisConnected
メソッドを呼び出します。
以下はチャット接続状態を確認するためのサンプルコードです。
接続イベント管理¶
Hive はチャットソケットサーバーの接続状態を検出し、状態変更イベントをアプリに継続的に配信します。詳細なイベント処理方法については、イベント管理 > 接続イベント ドキュメントを参照してください。