聊天服务器连接¶

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

连接请求¶

要连接到聊天，请调用Chat类的connect方法。

这是一个请求聊天连接的示例代码。

Warning

Hive SDK 聊天功能仅可由使用 Hive SDK 认证功能登录的用户（包括访客账户）使用，并且已被发放 PlayerID。

Unity虚幻引擎C++KotlinJava斯威夫特Objective-C

using hive;

Chat.connect((ResultAPI result) => {
    if (result.isSuccess()) {
        // API Call Success
    }
});

#include "HiveChat.h"

FHiveChat::Connect(FHiveChatOnResultDelegate::CreateLambda([this](const FHiveResultAPI& Result) {
    if (Result.IsSuccess()) {
        // API调用成功
    }
}));

#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;

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

import com.hive.Chat;
import com.hive.ResultAPI;

Chat.connect(object : Chat.ConnectListener {
    override fun onResult(result: ResultAPI) {
        if (result.isSuccess) {
            // API Call Success
        }
    }
})

import com.hive.Chat;

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

import HIVEService

ChatInterface.connect { result in
    if result.isSuccess {
        // API Call Success
    }
}

#import "HIVEService.h"

[HiveChat connectWithHandler:^(HIVEResultAPI * result) {
    if (result.isSuccess) {
        // API调用成功
    }
}];

重新连接请求¶

Note

在临时网络断开或（仅限iOS）在后台和前台之间切换时，SDK将自动尝试重新连接网络一次。

如果由于网络条件导致聊天套接字服务器连接断开，您可以请求聊天重新连接。如果您在聊天套接字服务器断开后的10分钟内请求重新连接，它将尝试自动加入您之前参与的频道。重新连接请求的结果将返回成功加入的频道列表和未能加入的频道列表。

当请求聊天重新连接时，调用Chat类的reconnect方法。这里是请求聊天重新连接的示例代码。

Unity虚幻引擎C++KotlinJava斯威夫特Objective-C

using hive;

Chat.reconnect((ResultAPI result, List<String> channelIds, List<String> failChannelIds) => {
    if (result.isSuccess()) {
        // API Call Success
    }
});

#include "HiveChat.h"

FHiveChat::Reconnect(FHiveChatOnReconnectDelegate::CreateLambda([this](const FHiveResultAPI& Result, const TArray<FString>& ChannelIds, const TArray<FString>& FailChannelIds) {
    if (Result.IsSuccess()) {
        // API 调用成功
    }
}));

#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;

Chat::reconnect([=](ResultAPI const & result, std::vector<std::string>channelIds, std::vector<std::string>failChannelIds) {
    if (result.isSuccess()) {
        // API调用成功
    }
});

import com.hive.Chat;
import com.hive.ResultAPI;

Chat.reconnect(object : Chat.ReconnectListener {
    override fun onResult(result: ResultAPI, channelIds: ArrayList<String>, failChannelIds: ArrayList<String>) {
        if (result.isSuccess) {
            // API调用成功
        }
    }
})

import com.hive.Chat;

Chat.reconnect(result, channelIds, failChannelIds -> {
    if (result.isSuccess()) {
        // API Call Success
    }
});

import HIVEService

ChatInterface.connect { result, channelIds, failChannelIds in
    if result.isSuccess {
        // API Call Success
    }
}

#import "HIVEService.h"

[HiveChat reconnectWithHandler:^(HIVEResultAPI * result, NSArray<NSString *> * channelIds,  NSArray<NSString *> * failChannelIds) {
    if (result.isSuccess) {
        // API调用成功
    }
}];

断开连接请求¶

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

Note

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

Unity虚幻引擎C++KotlinJava斯威夫特Objective-C

using hive;

Chat.disconnect((ResultAPI result) => {
    if (result.isSuccess()) {
        // API Call Success
    }
});

#include "HiveChat.h"

FHiveChat::Disconnect(FHiveChatOnResultDelegate::CreateLambda([this](const FHiveResultAPI& Result) {
    if (Result.IsSuccess()) {
        // API调用成功
    }
}));

#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 调用成功
    }
}];

检查连接状态¶

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

这是一个检查聊天连接状态的示例代码。

Unity虚幻引擎C++KotlinJava斯威夫特Objective-C

using hive;

Boolean isConnected = Chat.isConnected();

#include "HiveChat.h"

bool IsConnected = FHiveChat::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 聊天套接字服务器检测连接状态，并持续将状态变化事件传递给应用程序。有关详细的事件处理方法，请参阅事件管理 > 连接事件文档。