The Hive Chat service provides essential features for seamless chat within the app, including real-time chat, group chat, one-on-one chat, and user blocking functionality. More...

Classes
class	FHiveChat
	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...

class	FHiveChannel
	채팅 채널 정보 More...

class	FHiveChannelPage
	채널 조회 페이지 정보 More...

class	FHiveMember
	채널 멤버 정보 More...

class	FHiveBlockMember
	차단된 사용자 정보 More...

class	FHiveCreateChannelParams
	채널 생성 파라미터 More...

class	FHiveGetChannelsParams
	채널 목록 조회 파라미터 More...

class	FHiveEnterChannelParams
	채널 입장 파라미터 More...

class	FHiveChannelSendMessageParams
	채널 메시지 전송 파라미터 More...

class	FHiveDirectSendMessageParams
	1:1 메시지 전송 파라미터 More...

class	FHiveEnteredMember
	입장 멤버 정보 More...

class	FHiveExitedMember
	퇴장 멤버 정보 More...

class	FHiveDeletedChannel
	삭제된 채널 정보 More...

class	FHiveChannelNoticeMessage
	채널 공지 메시지 정보 More...

class	FHiveChannelMessage
	채널 메시지 정보 More...

class	FHiveDirectMessage
	1:1 메시지 정보 More...

class	FHiveChannelListener
	채널 이벤트 리스너 More...

class	FHiveDirectMessageListener
	1:1 메시지 리스너 More...

class	FHiveConnectionListener
	연결 리스너 More...

Enumerations
enum class	EHiveChannelType
	채팅 채널 타입 정보 More...

Functions
static void	FHiveChat::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	FHiveChat::GetChannels (TOptional< FHiveGetChannelsParams > params, const FHiveChatOnGetChannelsDelegate &Delegate)
	Get channel list Retrieves a list of accessible channels. More...

static void	FHiveChat::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	FHiveChat::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	FHiveChat::DeleteChannel (const FString &channelId, const FHiveChatOnResultDelegate &Delegate)
	Delete channel Receives the channel ID and deletes the corresponding channel. More...

static void	FHiveChat::EnterChannel (const FHiveEnterChannelParams &params, const FHiveChatOnResultDelegate &Delegate)
	Enter channel Receives the channel ID and connects to the channel. More...

static void	FHiveChat::ExitChannel (const FString &channelId, const FHiveChatOnResultDelegate &Delegate)
	Exit channel Receives the channel ID and exits the corresponding channel. More...

static void	FHiveChat::GetChannelsByUser (const FHiveChatOnGetChannelsByUserDelegate &Delegate)
	Get a list of channels the user is participating in. More...

static void	FHiveChat::GetBlockMembers (const FHiveChatOnGetBlockMembersDelegate &Delegate)
	Get a list of blocked users. More...

static void	FHiveChat::BlockMember (int64 blockPlayerId, const FHiveChatOnResultDelegate &Delegate)
	Block user Receives the user ID and blocks the corresponding user. More...

static void	FHiveChat::UnblockMember (int64 blockPlayerId, const FHiveChatOnResultDelegate &Delegate)
	Unblock user Receives the user ID and unblocks the corresponding user. More...

static void	FHiveChat::Connect (const FString &extraData, const FHiveChatOnResultDelegate &Delegate)
	Connects the Chat Server Attempts to connect to the Chat Server. More...

static void	FHiveChat::Disconnect (const FHiveChatOnResultDelegate &Delegate)
	Disconnects the Chat Server Disconnects from the Chat Server. More...

static void	FHiveChat::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	FHiveChat::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	FHiveChat::AddChannelListener (const FString &uniqueKey, FHiveChannelListener *listener)
	Register Channel Listener Register a listener to receive channel events. More...

static void	FHiveChat::AddDirectMessageListener (const FString &uniqueKey, FHiveDirectMessageListener *listener)
	Register Direct Message Listener Register a listener to receive 1:1 messages. More...

static void	FHiveChat::AddConnectionListener (const FString &uniqueKey, FHiveConnectionListener *listener)
	Register Connection Listener Register a listener to receive the connection status of the Chat Server. More...

static void	FHiveChat::RemoveChannelListener (const FString &uniqueKey)
	Remove Channel Listener Remove the registered channel listener. More...

static void	FHiveChat::RemoveDirectMessageListener (const FString &uniqueKey)
	Remove Direct Message Listener Remove the registered 1:1 message listener. More...

static void	FHiveChat::RemoveConnectionListener (const FString &uniqueKey)
	Remove Connection Listener Remove the registered connection listener. More...

static bool	FHiveChat::IsConnected ()
	Check the socket connection status Check if the socket is currently connected. More...

Detailed Description

The Hive Chat service provides essential features for seamless chat within the app, including real-time chat, group chat, one-on-one chat, and user blocking functionality.

Enumeration Type Documentation

◆ EHiveChannelType

enum class EHiveChannelType

strong

채팅 채널 타입 정보

Function Documentation

◆ AddChannelListener()

static void FHiveChat::AddChannelListener	(	const FString &	uniqueKey,
		FHiveChannelListener *	listener
	)

static

Register Channel Listener
Register a listener to receive channel events.

Registered listeners receive events (messages, notice messages, channel access notifications, channel exit notifications, channel deletion notifications) whenever they occur.

Since: 4.25.0.0

◆ AddConnectionListener()

static void FHiveChat::AddConnectionListener	(	const FString &	uniqueKey,
		FHiveConnectionListener *	listener
	)

static

Register Connection Listener
Register a listener to receive the connection status of the Chat Server.

Registered listeners receive events whenever the connection status of the Chat Server changes.

Since: 4.25.0.0

◆ AddDirectMessageListener()

static void FHiveChat::AddDirectMessageListener	(	const FString &	uniqueKey,
		FHiveDirectMessageListener *	listener
	)

static

Register Direct Message Listener
Register a listener to receive 1:1 messages.

Registered listeners receive events whenever a 1:1 message occurs.

Since: 4.25.0.0

◆ BlockMember()

static void FHiveChat::BlockMember	(	int64	blockPlayerId,
		const FHiveChatOnResultDelegate &	Delegate
	)

static

Block user
Receives the user ID and blocks the corresponding user.

The result of blocking the user is delivered through the listener.

Since: 4.25.0.0

◆ Connect()

static void FHiveChat::Connect	(	const FString &	extraData,
		const FHiveChatOnResultDelegate &	Delegate
	)

static

Connects the Chat Server
Attempts to connect to the Chat Server.

The result of the connection is delivered through the listener.

Since: 4.25.0.0

◆ CreateChannel()

static void FHiveChat::CreateChannel	(	FHiveCreateChannelParams const &	params,
		const FHiveChatOnResultDelegate &	Delegate
	)

static

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.

The result of creating a channel is delivered through the listener.

Since: 4.25.0.0

◆ DeleteChannel()

static void FHiveChat::DeleteChannel	(	const FString &	channelId,
		const FHiveChatOnResultDelegate &	Delegate
	)

static

Delete channel
Receives the channel ID and deletes the corresponding channel.

The result of deleting the channel is delivered through the listener.

Since: 4.25.0.0

◆ Disconnect()

static void FHiveChat::Disconnect ( const FHiveChatOnResultDelegate & Delegate )

static

Disconnects the Chat Server
Disconnects from the Chat Server.

The result of the disconnection is delivered through the listener.

Since: 4.25.0.0

◆ EnterChannel()

static void FHiveChat::EnterChannel	(	const FHiveEnterChannelParams &	params,
		const FHiveChatOnResultDelegate &	Delegate
	)

static

Enter channel
Receives the channel ID and connects to the channel.

If it is not a PUBLIC channel, you must enter the password.
The result of entering the channel is delivered through the listener.

Since: 4.25.0.0

◆ ExitChannel()

static void FHiveChat::ExitChannel	(	const FString &	channelId,
		const FHiveChatOnResultDelegate &	Delegate
	)

static

Exit channel
Receives the channel ID and exits the corresponding channel.

The result of exiting the channel is delivered through the listener.

Since: 4.25.0.0

◆ GetBlockMembers()

static void FHiveChat::GetBlockMembers ( const FHiveChatOnGetBlockMembersDelegate & Delegate )

static

Get a list of blocked users.

Retrieves a list of blocked users.
The blocked user list includes the ID of the blocked user and the time of blocking.
The result of the blocked user list retrieval is delivered through the listener.

Since: 4.25.0.0

◆ GetChannelInfo()

static void FHiveChat::GetChannelInfo	(	const FString &	channelId,
		const FHiveChatOnGetChannelInfoDelegate &	Delegate
	)

static

Get channel information
Receives the channel ID and retrieves the information of the corresponding channel.

The result of the query includes information about the channel and a list of members participating in the channel.

Since: 4.25.0.0

◆ GetChannelMembers()

static void FHiveChat::GetChannelMembers	(	const FString &	channelId,
		const FHiveChatOnGetChannelMembersDelegate &	Delegate
	)

static

Get channel members
Receives the channel ID and retrieves the list of members in the corresponding channel.

The result of the query includes a list of members in the corresponding channel.

Since: 4.25.0.0

◆ GetChannels()

static void FHiveChat::GetChannels	(	TOptional< FHiveGetChannelsParams >	params,
		const FHiveChatOnGetChannelsDelegate &	Delegate
	)

static

Get channel list
Retrieves a list of accessible channels.

You can specify the channel type, channel name, page order, page size, and page number.
The result of the channel list retrieval is delivered through the listener.

Since: 4.25.0.0

◆ GetChannelsByUser()

static void FHiveChat::GetChannelsByUser ( const FHiveChatOnGetChannelsByUserDelegate & Delegate )

static

Get a list of channels the user is participating in.

Retrieves a list of channels the user is participating in.
The result of the channel list retrieval is delivered through the listener.

Since: 4.25.0.0

◆ IsConnected()

static bool FHiveChat::IsConnected ( )

static

Check the socket connection status
Check if the socket is currently connected.

Since: 4.25.0.0

◆ RemoveChannelListener()

static void FHiveChat::RemoveChannelListener ( const FString & uniqueKey )

static

Remove Channel Listener
Remove the registered channel listener.

Since: 4.25.0.0

◆ RemoveConnectionListener()

static void FHiveChat::RemoveConnectionListener ( const FString & uniqueKey )

static

Remove Connection Listener
Remove the registered connection listener.

Since: 4.25.0.0

◆ RemoveDirectMessageListener()

static void FHiveChat::RemoveDirectMessageListener ( const FString & uniqueKey )

static

Remove Direct Message Listener
Remove the registered 1:1 message listener.

Since: 4.25.0.0

◆ SendMessageWithChannelSendMessageParams()

static void FHiveChat::SendMessageWithChannelSendMessageParams	(	FHiveChannelSendMessageParams const &	params,
		const FHiveChatOnResultDelegate &	Delegate
	)

static

Send a channel message
Receives the channel ID and message and sends the message to the corresponding channel.

The result of sending the message is delivered through the listener.

Since: 4.25.0.0

◆ SendMessageWithDirectSendMessageParams()

static void FHiveChat::SendMessageWithDirectSendMessageParams	(	FHiveDirectSendMessageParams const &	params,
		const FHiveChatOnResultDelegate &	Delegate
	)

static

Send a 1:1 message
Receives the recipient ID and message and sends the message to the corresponding user.

The result of sending the message is delivered through the listener.

Since: 4.25.0.0

◆ UnblockMember()

static void FHiveChat::UnblockMember	(	int64	blockPlayerId,
		const FHiveChatOnResultDelegate &	Delegate
	)

static

Unblock user
Receives the user ID and unblocks the corresponding user.

The result of unblocking the user is delivered through the listener.

Since: 4.25.0.0

HIVE SDK for Unreal Engine

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ EHiveChannelType

Function Documentation

◆ AddChannelListener()

◆ AddConnectionListener()

◆ AddDirectMessageListener()

◆ BlockMember()

◆ Connect()

◆ CreateChannel()

◆ DeleteChannel()

◆ Disconnect()

◆ EnterChannel()

◆ ExitChannel()

◆ GetBlockMembers()

◆ GetChannelInfo()

◆ GetChannelMembers()

◆ GetChannels()

◆ GetChannelsByUser()

◆ IsConnected()

◆ RemoveChannelListener()

◆ RemoveConnectionListener()

◆ RemoveDirectMessageListener()

◆ SendMessageWithChannelSendMessageParams()

◆ SendMessageWithDirectSendMessageParams()

◆ UnblockMember()