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...
Public Member Functions | |
delegate void | onConnect (ResultAPI result) |
the result after connecting to the Hive chat server More... | |
delegate void | onReconnect (ResultAPI result, List< String > channelIds, List< String > failChannelIds) |
the result after reconnecting to the Hive chat server More... | |
delegate void | onDisconnect (ResultAPI result) |
the result after disconnecting from the Hive chat server More... | |
delegate void | onChannelSendMessage (ResultAPI result, ChannelSendMessageParams retryParams) |
Listener for delivering the result after sending a channel message More... | |
delegate void | onDirectSendMessage (ResultAPI result, DirectSendMessageParams retryParams) |
Listener for delivering the result after sending a 1:1 message More... | |
delegate void | onCreateChannel (ResultAPI result) |
the result after channel creation More... | |
delegate void | onGetChannels (ResultAPI result, List< Channel > channels, ChannelPage channelPage) |
The result after retrieving the list of channels. More... | |
delegate void | onGetChannelInfo (ResultAPI result, Channel channel, List< Member > members) |
The result after retrieving channel information. More... | |
delegate void | onGetChannelMembers (ResultAPI result, List< Member > members) |
The result after retrieving the list of channel members. More... | |
delegate void | onDeleteChannel (ResultAPI result) |
The result after deleting the channel. More... | |
delegate void | onEnterChannel (ResultAPI result) |
The result after entering the channel. More... | |
delegate void | onEixtChannel (ResultAPI result) |
The result after exiting the channel. More... | |
delegate void | onGetChannelsByUser (ResultAPI result, List< Channel > channels) |
The result after retrieving the list of channels by user. More... | |
delegate void | onGetBlockMembers (ResultAPI result, List< BlockMember > blockMembers) |
The result after retrieving the list of blocked members. More... | |
delegate void | onBlockMember (ResultAPI result) |
The result after blocking a member. More... | |
delegate void | onUnblockMember (ResultAPI result) |
The result after unblocking a member. More... | |
Static Public Member Functions | |
static void | connect (String extraData, onConnect listener) |
[Deprecated] The result after attempting to connect to the Hive chat server This is the first API that must be called before accessing the Hive chat feature. More... | |
static void | connect (onConnect listener) |
The result after attempting to connect to the Hive chat server This is the first API that must be called before accessing the Hive chat feature. More... | |
static void | reconnect (onReconnect listener) |
Reconnect to Hive chat server Reconnects to the Hive chat server. More... | |
static void | disconnect (onDisconnect listener) |
Disconnects from the Hive chat server This API is automatically called when the authenticated user information is signed out. More... | |
static Boolean | isConnected () |
Retrieves the current user's Hive chat server connection status Checks the connection status to the Hive chat server. More... | |
static void | sendMessage (ChannelSendMessageParams param) |
Send channel message Sends a message to the channel the user has joined, and allows configuring message transmission details by creating a ChannelSendMessageParams object. More... | |
static void | sendMessage (ChannelSendMessageParams param, onChannelSendMessage listener) |
Send channel message Sends a message to the channel the user has joined, with details configured using a ChannelSendMessageParams object. More... | |
static void | sendMessage (DirectSendMessageParams param) |
Send 1:1 message Sends a message to a specific target user, and allows configuring message transmission details by creating a DirectSendMessageParams object. More... | |
static void | sendMessage (DirectSendMessageParams param, onDirectSendMessage listener) |
Send 1:1 message Sends a message to a specific target user, with details configured using a DirectSendMessageParams object. More... | |
static void | addConnectionHandler (String uniqueKey, ConnectionHandler connectionHandler) |
Detects the connection status with the Hive chat server and listens for status change events. More... | |
static void | addChannelHandler (String uniqueKey, ChannelHandler channelHandler) |
Detects events between the connected user and the Hive chat server channel, and listens for change events. More... | |
static void | addDirectMessageHandler (String uniqueKey, DirectMessageHandler directMessageHandler) |
Detects 1:1 message events delivered to the connected user on the Hive chat server and listens for these events. More... | |
static void | addUserHandler (String uniqueKey, UserHandler userHandler) |
Registers a listener that detects and receives user-related events on the connected Hive chat server. More... | |
static void | addCustomDataHandler (String uniqueKey, CustomDataHandler customDataHandler) |
Registers a listener that detects and receives custom data for the connected user on the Hive chat server. More... | |
static void | removeConnectionHandler (String uniqueKey) |
Removes the registered connection event handler (addConnectionHandler) Removes the registered connection event handler. More... | |
static void | removeChannelHandler (String uniqueKey) |
Removes the registered channel event handler (addChannelHandler) Removes the registered channel event handler. More... | |
static void | removeDirectMessageHandler (String uniqueKey) |
Removes the registered 1:1 message event handler (addDirectMessageHandler) Removes the registered 1:1 message event handler. More... | |
static void | removeUserHandler (String uniqueKey) |
Removes the registered user event listener (addUserHandler) Removes the registered UserHandler by uniqueKey, and stops receiving user-related events such as DirectMessage and NoticeMessage. More... | |
static void | removeCustomDataHandler (String uniqueKey) |
Removes the registered custom data event listener (addCustomDataHandler) Removes the registered CustomDataHandler by uniqueKey, and stops receiving custom data related to the specified user. More... | |
static void | createChannel (CreateChannelParams param, onCreateChannel listener) |
Create channel Creates a new conversation channel. More... | |
static void | getChannels (GetChannelsParams param, onGetChannels listener) |
Retrieve list of currently created channels Retrieves the list of currently created channels. More... | |
static void | getChannelInfo (String channelId, onGetChannelInfo listener) |
Retrieve channel information Retrieves the detailed information of a specific channel. More... | |
static void | getChannelMembers (String channelId, onGetChannelMembers listener) |
Retrieve channel participant information Retrieves the participant information of a specific channel. More... | |
static void | deleteChannel (String channelId, onDeleteChannel listener) |
Delete channel Deletes the channel. More... | |
static void | enterChannel (EnterChannelParams param, onEnterChannel listener) |
Enter channel Enters the channel. More... | |
static void | exitChannel (String channelId, onEixtChannel listener) |
Exit Channel Exit the channel the current user is participating in. More... | |
static void | getChannelsByUser (onGetChannelsByUser listener) |
Retrieve channels the user is participating in Retrieves the list of channels the current user is participating in. More... | |
static void | getBlockMembers (onGetBlockMembers listener) |
Get blocked member The current user retrieves the list of members blocked. More... | |
static void | blockMember (Int64 blockPlayerId, onBlockMember listener) |
Block member The current user blocks a specific member. More... | |
static void | unblockMember (Int64 blockPlayerId, onUnblockMember listener) |
Unblock member The current user unblocks a specific member. More... | |
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.
Additionally, the AI chat filtering feature helps detect and block prohibited words and promotional text, enhancing the user experience.