HIVE SDK for Unreal Engine

HiveChat.h
Go to the documentation of this file.
1
19#pragma once
20
21#include "CoreMinimal.h"
22#include "Impl/HiveChatImpl.h"
23
24HIVESDK_API IHiveChatImpl* GetChatInstance();
25
39class HIVESDK_API FHiveChat
40{
41public:
59 static void CreateChannel(FHiveCreateChannelParams const & params, const FHiveChatOnResultDelegate& Delegate);
60
78 static void GetChannels(TOptional<FHiveGetChannelsParams> params, const FHiveChatOnGetChannelsDelegate& Delegate);
79
95 static void GetChannelInfo(const FString& channelId, const FHiveChatOnGetChannelInfoDelegate& Delegate);
96
112 static void GetChannelMembers(const FString& channelId, const FHiveChatOnGetChannelMembersDelegate& Delegate);
113
129 static void DeleteChannel(const FString& channelId, const FHiveChatOnResultDelegate& Delegate);
130
148 static void EnterChannel(const FHiveEnterChannelParams& params, const FHiveChatOnResultDelegate& Delegate);
149
165 static void ExitChannel(const FString& channelId, const FHiveChatOnResultDelegate& Delegate);
166
182 static void GetChannelsByUser(const FHiveChatOnGetChannelsByUserDelegate& Delegate);
183
201 static void GetBlockMembers(const FHiveChatOnGetBlockMembersDelegate& Delegate);
202
218 static void BlockMember(int64 blockPlayerId, const FHiveChatOnResultDelegate& Delegate);
219
235 static void UnblockMember(int64 blockPlayerId, const FHiveChatOnResultDelegate& Delegate);
236
252 static void Connect(const FString& extraData, const FHiveChatOnResultDelegate& Delegate);
253
269 static void Disconnect(const FHiveChatOnResultDelegate& Delegate);
270
286 static void SendMessageWithChannelSendMessageParams(FHiveChannelSendMessageParams const & params, const FHiveChatOnResultDelegate& Delegate);
287
303 static void SendMessageWithDirectSendMessageParams(FHiveDirectSendMessageParams const & params, const FHiveChatOnResultDelegate& Delegate);
304
320 static void AddChannelListener(const FString& uniqueKey, FHiveChannelListener* listener);
321
337 static void AddDirectMessageListener(const FString& uniqueKey, FHiveDirectMessageListener* listener);
338
354 static void AddConnectionListener(const FString& uniqueKey, FHiveConnectionListener* listener);
355
369 static void RemoveChannelListener(const FString& uniqueKey);
370
384 static void RemoveDirectMessageListener(const FString& uniqueKey);
385
399 static void RemoveConnectionListener(const FString& uniqueKey);
400
414 static bool IsConnected();
415};
채널 이벤트 리스너
Definition: HiveChatTypes.h:318
채널 메시지 전송 파라미터
Definition: HiveChatTypes.h:178
HiveChat provides essential features for smooth chatting in games, such as real-time,...
Definition: HiveChat.h:40
연결 리스너
Definition: HiveChatTypes.h:348
채널 생성 파라미터
Definition: HiveChatTypes.h:123
1:1 메시지 리스너
Definition: HiveChatTypes.h:335
1:1 메시지 전송 파라미터
Definition: HiveChatTypes.h:194
채널 입장 파라미터
Definition: HiveChatTypes.h:162
static bool IsConnected()
Check the socket connection status Check if the socket is currently connected.
static void Disconnect(const FHiveChatOnResultDelegate &Delegate)
Disconnects the Chat Server Disconnects from the Chat Server.
static void GetChannelInfo(const FString &channelId, const FHiveChatOnGetChannelInfoDelegate &Delegate)
Get channel information Receives the channel ID and retrieves the information of the corresponding c...
static void GetChannels(TOptional< FHiveGetChannelsParams > params, const FHiveChatOnGetChannelsDelegate &Delegate)
Get channel list Retrieves a list of accessible channels.
static void GetChannelsByUser(const FHiveChatOnGetChannelsByUserDelegate &Delegate)
Get a list of channels the user is participating in.
static void CreateChannel(FHiveCreateChannelParams const &params, const FHiveChatOnResultDelegate &Delegate)
Create a channel Channel Name, Maximum Number of People, and Type can be specified,...
static void RemoveConnectionListener(const FString &uniqueKey)
Remove Connection Listener Remove the registered connection listener.
static void Connect(const FString &extraData, const FHiveChatOnResultDelegate &Delegate)
Connects the Chat Server Attempts to connect to the Chat Server.
static void DeleteChannel(const FString &channelId, const FHiveChatOnResultDelegate &Delegate)
Delete channel Receives the channel ID and deletes the corresponding channel.
static void GetBlockMembers(const FHiveChatOnGetBlockMembersDelegate &Delegate)
Get a list of blocked users.
static void RemoveDirectMessageListener(const FString &uniqueKey)
Remove Direct Message Listener Remove the registered 1:1 message listener.
static void EnterChannel(const FHiveEnterChannelParams &params, const FHiveChatOnResultDelegate &Delegate)
Enter channel Receives the channel ID and connects to the channel.
static void SendMessageWithDirectSendMessageParams(FHiveDirectSendMessageParams const &params, const FHiveChatOnResultDelegate &Delegate)
Send a 1:1 message Receives the recipient ID and message and sends the message to the corresponding ...
static void BlockMember(int64 blockPlayerId, const FHiveChatOnResultDelegate &Delegate)
Block user Receives the user ID and blocks the corresponding user.
static void AddChannelListener(const FString &uniqueKey, FHiveChannelListener *listener)
Register Channel Listener Register a listener to receive channel events.
static void AddConnectionListener(const FString &uniqueKey, FHiveConnectionListener *listener)
Register Connection Listener Register a listener to receive the connection status of the Chat Server...
static void RemoveChannelListener(const FString &uniqueKey)
Remove Channel Listener Remove the registered channel listener.
static void SendMessageWithChannelSendMessageParams(FHiveChannelSendMessageParams const &params, const FHiveChatOnResultDelegate &Delegate)
Send a channel message Receives the channel ID and message and sends the message to the correspondin...
static void GetChannelMembers(const FString &channelId, const FHiveChatOnGetChannelMembersDelegate &Delegate)
Get channel members Receives the channel ID and retrieves the list of members in the corresponding c...
static void ExitChannel(const FString &channelId, const FHiveChatOnResultDelegate &Delegate)
Exit channel Receives the channel ID and exits the corresponding channel.
static void AddDirectMessageListener(const FString &uniqueKey, FHiveDirectMessageListener *listener)
Register Direct Message Listener Register a listener to receive 1:1 messages.
static void UnblockMember(int64 blockPlayerId, const FHiveChatOnResultDelegate &Delegate)
Unblock user Receives the user ID and unblocks the corresponding user.
Copyright © Com2uS Platform Corporation. All Right Reserved. Terms of Use Privacy Policy