跳转至

聊天服务器连接

Hive SDK 聊天功能使用 WebSocket 通信 与 Hive 聊天套接字服务器。因此,要使用 Hive SDK 聊天功能,您必须首先参考下面的指南以连接到 Hive 聊天套接字服务器。

连接请求

要连接到聊天,请调用Chat类的connect方法。此时,您可以将字符串值作为extraData参数传递,以提供附加信息。例如,如果您将应用程序数据库管理的应用程序用户昵称字符串作为附加信息传递,则可以在聊天窗口中用作聊天昵称,或用于实现进入频道时的事件消息,例如“~已进入。”

以下是请求聊天连接的示例代码。

Warning

Hive SDK 聊天功能仅可供使用 Hive SDK 认证功能登录的用户(包括访客账户)使用,并且已被发放 PlayerID

using hive;

String extraData = "EXTRA_DATA";
Chat.connect(extraData, (ResultAPI result) => {
    if (result.isSuccess()) {
        // API Call Success
    }
});
#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;

Chat::connect(extraData, [=](ResultAPI const & result) {
    if (result.isSuccess()) {
        // API Call Success
    }
});
import com.hive.Chat;
import com.hive.ResultAPI;

val extraData = "EXTRA_DATA"
Chat.connect(extraData, object : Chat.ConnectListener {
    override fun onResult(result: ResultAPI) {
        if (result.isSuccess) {
            // API Call Success
        }
    }
})
import com.hive.Chat;

String extraData = "EXTRA_DATA";
Chat.connect(extraData, result -> {
    if (result.isSuccess()) {
        // API Call Success
    }
});
import HIVEService

let extraData = "EXTRA_DATA"
ChatInterface.connect(extraData: extraData) { result in
    if result.isSuccess {
        // API Call Success
    }
}
#import "HIVEService.h"

NSString *extraData = @"EXTRA_DATA";
[HiveChat connectWithExtraData:extraData handler:^(HIVEResultAPI * result) {
    if (result.isSuccess) {
        // API Call Success
    }
}];

断开连接请求

要断开聊天,请调用Chat类的disconnect()方法。以下是一个断开聊天的示例代码。

Note

当应用用户帐户注销时,聊天断开请求会自动执行。

using hive;

Chat.disconnect((ResultAPI result) => {
    if (result.isSuccess()) {
        // API Call Success
    }
});
#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;

Chat::disconnect([=](ResultAPI const & result) {
    if (result.isSuccess()) {
        // API Call Success
    }
});
import com.hive.Chat;
import com.hive.ResultAPI;

Chat.disconnect(object : Chat.DisconnectListener {
    override fun onResult(result: ResultAPI) {
        if (result.isSuccess) {
            // API 调用成功
        }
    }
})
import com.hive.Chat;

Chat.disconnect(result -> {
    if (result.isSuccess()) {
        // API Call Success
    }
});
import HIVEService

ChatInterface.disconnect(result) {
    if result.isSuccess {
        // API Call Success
    }
}
#import "HIVEService.h"

[HiveChat disconnectWithHandler:^(HIVEResultAPI * result) {
    if (result.isSuccess) {
        // API Call Success
    }
}];

连接状态检查

检查应用用户当前是否连接到聊天。调用Chat类的isConnected方法。

以下是检查聊天连接状态的示例代码。

using hive;

Boolean isConnected = Chat.isConnected();
#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;

bool isConnected = Chat::isConnected();
import com.hive.Chat;

val isConnected = Chat.isConnected()
import com.hive.Chat;

Boolean isConnected = Chat.isConnected();
import HIVEService

let isConnected = ChatInterface.isConnected()
#import "HIVEService.h"

bool isConnected = [ChatInterface isConnected];

连接事件管理

Hive 检测聊天套接字服务器的连接状态,并持续将状态变化事件传递给应用程序。有关详细的事件处理方法,请参阅 事件管理 > 连接事件 文档。