HIVE SDK for Unreal Engine

Static Public Member Functions | List of all members
FHiveChat Class Reference

HiveChat provides essential features for smooth chatting in games, such as real-time, group, 1:1 chat, and user blocking functions, which can increase user collaboration and improve game play satisfaction. More...

#include <HiveChat.h>

Static Public Member Functions

static void CreateChannel (FHiveCreateChannelParams const &params, const FHiveChatOnResultDelegate &Delegate)
 Create a channel
Channel Name, Maximum Number of People, and Type can be specified, and if it is not PUBLIC, a password must also be specified. More...
 
static void GetChannels (TOptional< FHiveGetChannelsParams > params, const FHiveChatOnGetChannelsDelegate &Delegate)
 Get channel list
Retrieves a list of accessible channels. More...
 
static void GetChannelInfo (const FString &channelId, const FHiveChatOnGetChannelInfoDelegate &Delegate)
 Get channel information
Receives the channel ID and retrieves the information of the corresponding channel. More...
 
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 channel. More...
 
static void DeleteChannel (const FString &channelId, const FHiveChatOnResultDelegate &Delegate)
 Delete channel
Receives the channel ID and deletes the corresponding channel. More...
 
static void EnterChannel (const FHiveEnterChannelParams &params, const FHiveChatOnResultDelegate &Delegate)
 Enter channel
Receives the channel ID and connects to the channel. More...
 
static void ExitChannel (const FString &channelId, const FHiveChatOnResultDelegate &Delegate)
 Exit channel
Receives the channel ID and exits the corresponding channel. More...
 
static void GetChannelsByUser (const FHiveChatOnGetChannelsByUserDelegate &Delegate)
 Get a list of channels the user is participating in. More...
 
static void GetBlockMembers (const FHiveChatOnGetBlockMembersDelegate &Delegate)
 Get a list of blocked users. More...
 
static void BlockMember (int64 blockPlayerId, const FHiveChatOnResultDelegate &Delegate)
 Block user
Receives the user ID and blocks the corresponding user. More...
 
static void UnblockMember (int64 blockPlayerId, const FHiveChatOnResultDelegate &Delegate)
 Unblock user
Receives the user ID and unblocks the corresponding user. More...
 
static void Connect (const FString &extraData, const FHiveChatOnResultDelegate &Delegate)
 Connects the Chat Server
Attempts to connect to the Chat Server. More...
 
static void Disconnect (const FHiveChatOnResultDelegate &Delegate)
 Disconnects the Chat Server
Disconnects from the Chat Server. More...
 
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 corresponding channel. More...
 
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 user. More...
 
static void AddChannelListener (const FString &uniqueKey, FHiveChannelListener *listener)
 Register Channel Listener
Register a listener to receive channel events. More...
 
static void AddDirectMessageListener (const FString &uniqueKey, FHiveDirectMessageListener *listener)
 Register Direct Message Listener
Register a listener to receive 1:1 messages. More...
 
static void AddConnectionListener (const FString &uniqueKey, FHiveConnectionListener *listener)
 Register Connection Listener
Register a listener to receive the connection status of the Chat Server. More...
 
static void RemoveChannelListener (const FString &uniqueKey)
 Remove Channel Listener
Remove the registered channel listener. More...
 
static void RemoveDirectMessageListener (const FString &uniqueKey)
 Remove Direct Message Listener
Remove the registered 1:1 message listener. More...
 
static void RemoveConnectionListener (const FString &uniqueKey)
 Remove Connection Listener
Remove the registered connection listener. More...
 
static bool IsConnected ()
 Check the socket connection status
Check if the socket is currently connected. More...
 

Detailed Description

HiveChat provides essential features for smooth chatting in games, such as real-time, group, 1:1 chat, and user blocking functions, which can increase user collaboration and improve game play satisfaction.


Without additional complex development, you can use the AI chat filtering feature provided by Hive Chat to detect and block prohibited words and advertising chats, improving the user's play environment.

Since
4.25.0.0

The documentation for this class was generated from the following file:
Copyright © Com2uS Platform Corporation. All Right Reserved. Terms of Use Privacy Policy