This class manage HIVE Chat Service
More...
Classes | |
| class | Chat |
| 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 | Channel |
| 채팅 채널 정보 More... | |
| class | ChannelPage |
| 채널 조회 페이지 정보 More... | |
| class | Member |
| 채널 멤버 정보 More... | |
| class | BlockMember |
| 차단된 사용자 정보 More... | |
| class | CreateChannelParams |
| 채널 생성 파라미터 More... | |
| class | GetChannelsParams |
| 채널 목록 조회 파라미터 More... | |
| class | EnterChannelParams |
| 채널 입장 파라미터 More... | |
| class | ChannelSendMessageParams |
| 채널 메시지 전송 파라미터 More... | |
| class | DirectSendMessageParams |
| 1:1 메시지 전송 파라미터 More... | |
| class | ChannelMessageListQueryParams |
| 채널 대화 이력 조회 파라미터 More... | |
| class | EnteredMember |
| 입장 멤버 정보 More... | |
| class | ExitedMember |
| 퇴장 멤버 정보 More... | |
| class | DeletedChannel |
| 삭제된 채널 정보 More... | |
| class | ChannelNoticeMessage |
| 채널 공지 메시지 정보 More... | |
| class | ChannelMessage |
| 채널 메시지 정보 More... | |
| class | DirectMessage |
| 1:1 메시지 정보 More... | |
| class | NoticeMessage |
| 유저 대상 공지 메시지 정보 More... | |
| class | ChannelMessageListQueryResponse |
| 채널 대화 이력 정보 More... | |
| class | TranslationData |
| 메시지 번역 결과 More... | |
| class | Reaction |
| 리액션 More... | |
| class | ChannelListener |
| 채널 이벤트 리스너 More... | |
| class | DirectMessageListener |
| 1:1 메시지 리스너 More... | |
| class | UserListener |
| 유저 이벤트 리스너 More... | |
| class | ConnectionListener |
| 연결 리스너 More... | |
| class | CustomDataListener |
| 커스텀 데이터 리스너 More... | |
Enumerations | |
| enum class | ChannelType |
| 채팅 채널 타입 정보 More... | |
| enum class | SortType |
| 채널 정렬 타입 정보 More... | |
| enum class | ReasonType |
| 메시지 신고 사유 More... | |
Functions | |
| static void | Chat::createChannel (CreateChannelParams const ¶ms, onCreateChannel listener) |
| Create a channel Channel Name, Maximum Number of People, and Type can be specified. More... | |
| static void | Chat::getChannels (GetChannelsParams const *params, onGetChannels listener) |
| Get channel list Retrieves a list of accessible channels. More... | |
| static void | Chat::getChannelInfo (std::string const &channelId, onGetChannelInfo listener) |
| Get channel information Receives the channel ID and retrieves the information of the corresponding channel. More... | |
| static void | Chat::getChannelMembers (std::string const &channelId, onGetChannelMembers listener) |
| Get channel members Receives the channel ID and retrieves the list of members in the corresponding channel. More... | |
| static void | Chat::deleteChannel (std::string const &channelId, onDeleteChannel listener) |
| Delete channel Receives the channel ID and deletes the corresponding channel. More... | |
| static void | Chat::enterChannel (EnterChannelParams const ¶ms, onEnterChannel listener) |
| Enter channel Receives the channel ID and connects to the channel. More... | |
| static void | Chat::exitChannel (std::string const &channelId, onExitChannel listener) |
| Exit channel Receives the channel ID and exits the corresponding channel. More... | |
| static void | Chat::getChannelsByUser (onGetChannelsByUser listener) |
| Get a list of channels the user is participating in. More... | |
| static void | Chat::getBlockMembers (onGetBlockMembers listener) |
| Get a list of blocked users. More... | |
| static void | Chat::blockMember (int64_t blockPlayerId, onBlockMember listener) |
| Block user Receives the user ID and blocks the corresponding user. More... | |
| static void | Chat::unblockMember (int64_t blockPlayerId, onUnblockMember listener) |
| Unblock user Receives the user ID and unblocks the corresponding user. More... | |
| static void | Chat::translate (TranslateParams const ¶ms, onTranslate listener) |
| Message translation request. More... | |
| static void | Chat::reportMessage (ReportMessageParams const ¶ms, onResult listener) |
| Report a message Channel id, message id, message author, and report reason for the message can be specified. More... | |
| static void | Chat::connect (std::string const &extraData, onResult listener) |
| Connects the Chat Server (Deprecated) This method is no longer recommended and will be removed in future versions. More... | |
| static void | Chat::connect (onConnect listener) |
| Connects the Chat Server Attempts to connect to the Chat Server. More... | |
| static void | Chat::reconnect (onReconnect listener) |
| Reconnects to the Chat Server (Deprecated) This method is no longer recommended and will be removed in future versions. More... | |
| static void | Chat::disconnect (onDisconnect listener) |
| Disconnects the Chat Server Disconnects from the Chat Server. More... | |
| static void | Chat::sendMessageWithChannelSendMessageParams (ChannelSendMessageParams const ¶ms) |
| Send a channel message Receives the channel ID and message and sends the message to the corresponding channel. More... | |
| static void | Chat::sendMessageWithChannelSendMessageParams (ChannelSendMessageParams const ¶ms, onChannelSendMessage listener) |
| Send a channel message Receives the channel ID and message and sends the message to the corresponding channel. More... | |
| static void | Chat::sendMessageWithDirectSendMessageParams (DirectSendMessageParams const ¶ms) |
| Send a 1:1 message Receives the recipient ID and message and sends the message to the corresponding user. More... | |
| static void | Chat::sendMessageWithDirectSendMessageParams (DirectSendMessageParams const ¶ms, onDirectSendMessage listener) |
| Send a 1:1 message Receives the recipient ID and message and sends the message to the corresponding user. More... | |
| static void | Chat::addChannelListener (std::string const &uniqueKey, ChannelListener *listener) |
| Register Channel Listener Register a listener to receive channel events. More... | |
| static void | Chat::addDirectMessageListener (std::string const &uniqueKey, DirectMessageListener *listener) |
| Register Direct Message Listener Register a listener to receive 1:1 messages. More... | |
| static void | Chat::addUserListener (std::string const &uniqueKey, UserListener *listener) |
| Register User Listener Register a listener to receive user events. More... | |
| static void | Chat::addConnectionListener (std::string const &uniqueKey, ConnectionListener *listener) |
| Register Connection Listener Register a listener to receive the connection status of the Chat Server. More... | |
| static void | Chat::addCustomDataListener (std::string const &uniqueKey, CustomDataListener *listener) |
| Register Custom Data Listener More... | |
| static void | Chat::removeChannelListener (std::string const &uniqueKey) |
| Remove Channel Listener Remove the registered channel listener. More... | |
| static void | Chat::removeDirectMessageListener (std::string const &uniqueKey) |
| Remove Direct Message Listener Remove the registered 1:1 message listener. More... | |
| static void | Chat::removeUserListener (std::string const &uniqueKey) |
| Remove User Listener Remove the registered user event listener. More... | |
| static void | Chat::removeConnectionListener (std::string const &uniqueKey) |
| Remove Connection Listener Remove the registered connection listener. More... | |
| static void | Chat::removeCustomDataListener (std::string const &uniqueKey) |
| Remove Custom Data Listener More... | |
| static bool | Chat::isConnected () |
| Check the socket connection status Check if the socket is currently connected. More... | |
| virtual void | ConnectionListener::onConnected ()=0 |
| virtual void | ConnectionListener::onReconnectStarted ()=0 |
| virtual void | ConnectionListener::onReconnected (ResultAPI const &result, std::vector< std::string > const &channelIds, std::vector< std::string > const &failChannelIds)=0 |
This class manage HIVE Chat Service
|
strong |
채팅 채널 타입 정보
|
strong |
메시지 신고 사유
|
strong |
채널 정렬 타입 정보
|
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.
|
static |
|
static |
Register Custom Data Listener
|
static |
Register Direct Message Listener
Register a listener to receive 1:1 messages.
Registered listeners receive events whenever a 1:1 message occurs.
|
static |
Register User Listener
Register a listener to receive user events.
Registered listeners receive events (1:1 messages, notice messages) whenever they occur.
|
static |
Block user
Receives the user ID and blocks the corresponding user.
The result of blocking the user is delivered through the listener.
|
static |
|
static |
Connects the Chat Server (Deprecated)
This method is no longer recommended and will be removed in future versions.
Use connect(onConnect) instead.
|
static |
Create a channel
Channel Name, Maximum Number of People, and Type can be specified.
If it is not PUBLIC or ONEONONE, a password must also be specified.
If it is ONEONONE, a otherPlayerId must also be specified.
The result of creating a channel is delivered through the listener.
|
static |
Delete channel
Receives the channel ID and deletes the corresponding channel.
The result of deleting the channel is delivered through the listener.
|
static |
|
static |
Enter channel
Receives the channel ID and connects to the channel.
If it is not a PUBLIC or ONEONONE channel, you must enter the password.
The result of entering the channel is delivered through the listener.
|
static |
Exit channel
Receives the channel ID and exits the corresponding channel.
The result of exiting the channel is delivered through the listener.
|
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.
|
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.
|
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.
|
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.
ONEONONE channels are omitted from the search.
|
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.
ONEONONE channels are omitted from the search.
|
static |
Check the socket connection status
Check if the socket is currently connected.
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
static |
Reconnects to the Chat Server (Deprecated)
This method is no longer recommended and will be removed in future versions.
Use connect(onConnect) instead.
|
static |
|
static |
Remove Connection Listener
Remove the registered connection listener.
|
static |
Remove Custom Data Listener
|
static |
Remove Direct Message Listener
Remove the registered 1:1 message listener.
|
static |
Remove User Listener
Remove the registered user event listener.
|
static |
Report a message
Channel id, message id, message author, and report reason for the message can be specified.
Detailed report reason(reasonDetail) is only valid when the report reason type(reasonType) is Etc.
The result of reporting a message is delivered through the listener.
|
static |
Send a channel message
Receives the channel ID and message and sends the message to the corresponding channel.
To receive the sent channel message, you need to register an event handler using Chat.addChannelHandler.
|
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.
|
static |
Send a 1:1 message
Receives the recipient ID and message and sends the message to the corresponding user.
To receive the sent 1:1 message, you need to register an event handler using Chat.addDirectMessageHandler.
|
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.
|
static |
Message translation request.
Takes the target language and the message to be translated as input, and translates the message accordingly.
A single message can be translated into multiple languages.
|
static |
Unblock user
Receives the user ID and unblocks the corresponding user.
The result of unblocking the user is delivered through the listener.