Inheritance diagram for AccelByte.Api.Chat:

Public Member Functions
void	Connect ()
	Establish a websocket connection to chat service.
void	Disconnect ()
	Disconnect websocket connection from chat service.
void	RefreshToken (string newToken, ResultCallback callback)
	Send a new access token to be used in chat service.
void	CreatePersonalTopic (string otherUserId, ResultCallback< ChatActionTopicResponse > callback)
	Create a private topic with other user.
void	CreateGroupTopic (string groupName, string[] adminUserId, string[] memberUserIds, ResultCallback< ChatActionTopicResponse > callback)
	Create a group topic It can be used to let multiple users connect to each other.
void	CreateGroupTopic (string groupName, string[] adminUserId, string[] memberUserIds, CreateGroupTopicOptionalParameter optionalParameter, ResultCallback< ChatActionTopicResponse > callback)
	Create a group topic It can be used to let multiple users connect to each other.
void	JoinTopic (string topicId, ResultCallback< ChatActionTopicResponse > callback)
	Join a specific topic id.
void	DeleteTopic (string topicId, ResultCallback< ChatActionTopicResponse > callback)
	Delete a topic.
void	SendChatMessage (string topicId, string message, ResultCallback< SendChatResponse > callback)
	Send chat message to a topic.
void	QueryGroupTopic (string keyword, ResultCallback< QueryTopicResponse > callback, int offset=0, int limit=20)
	Query group topics that user is currently a part of.
void	QueryPersonalTopic (string keyword, ResultCallback< QueryTopicResponse > callback, int offset=0, int limit=20)
	Query personal topics that user is currently a part of.
void	QueryTopic (string keyword, ResultCallback< QueryTopicResponse > callback, int offset=0, int limit=20)
	Query group and personal topics that user is currently a part of.
void	QueryTopic (string topicId, ResultCallback< QueryTopicByIdResponse > callback)
	Query group and personal topic by topic ID.
void	QueryChat (string topicId, ResultCallback< QueryChatResponse > callback, int limit=20, DateTime lastChatCreatedAt=default(DateTime))
	Query chat messages within a topic.
void	BlockUser (string userId, ResultCallback< BlockUnblockResponse > callback)
	Block user.
void	UnblockUser (string userId, ResultCallback< BlockUnblockResponse > callback)
	Unblock user.
void	QuerySystemMessage (ResultCallback< QuerySystemMessagesResponse > callback, QuerySystemMessageRequest request=default)
	Query system messages in user's system inbox.
void	UpdateSystemMessages (HashSet< ActionUpdateSystemMessage > actionUpdateSystemMessages, ResultCallback< UpdateSystemMessagesResponse > callback)
	Update system message(s) in user system inbox.
void	DeleteSystemMessages (HashSet< string > messageIds, ResultCallback< DeleteSystemMessagesResponse > callback)
	Delete system message(s) in user system inbox.
void	GetSystemMessagesStats (ResultCallback< GetSystemMessageStatsResponse > callback, GetSystemMessageStatsRequest request=default)
	Get system messages stats.
void	DeleteGroupChat (string groupId, string chatId, ResultCallback callback)
	Delete a message from group chat (used by group moderator).
void	MuteGroupUserChat (string groupId, string userId, int durationInSeconds, ResultCallback callback)
	Mute user from group chat (used by group moderator).
void	UnmuteGroupUserChat (string groupId, string userId, ResultCallback callback)
	Unmute user from group chat (used by group moderator).
void	GetGroupChatSnapshot (string groupId, string chatId, ResultCallback< ChatSnapshotResponse > callback)
	Get chat snapshot (used by group moderator).
void	BanGroupUserChat (string groupId, List< string > userIds, ResultCallback< BanGroupChatResponse > callback)
	Ban users from group chat (used by group moderator).
void	UnbanGroupUserChat (string groupId, List< string > userIds, ResultCallback< UnbanGroupChatResponse > callback)
	Unban users from group chat (used by group moderator).
void	GetUserChatConfiguration (ResultCallback< GetUserChatConfigurationResponse > callback)
	Get chat configuration for current user.
void	SetUserChatConfiguration (bool isProfanityDisabled, ResultCallback< SetUserChatConfigurationResponse > callback)
	Set chat configuration for current user.

Properties
string	SessionId `[get]`
	Session Id of the connection to chat service.
bool	IsConnected `[get]`
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator `[get]`

Events
Action	Connected
	Event triggered when websocket connection successfully connected.
Action< WsCloseCode >	Disconnected
	Event triggered when a websocket connection is disconnected.
Action< EventAddRemoveFromTopic >	AddedToTopic
	Event triggered when user is added to a chat topic.
Action< EventAddRemoveFromTopic >	RemovedFromTopic
	Event triggered when user is added to a chat topic.
Action< EventTopicUpdated >	TopicDeleted
	Event triggered when a chat topic is deleted.
Action< EventNewChat >	NewChatMessage
	Event triggered when a new chat message is received.
Action< UserBannedNotification >	UserChatBanned
	Event triggered when user is banned from chatting when ban is CHAT_ALL, then user also will not receive new chat events.
Action< UserBannedNotification >	UserChatUnbanned
	Event triggered when user is unbanned from chatting.
Action< SystemMessageNotif >	NewSystemMessage
	Event triggered when user receive new system message.
Action< ChatMutedNotif >	ChatMuted
	Event triggered when user muted from group chat.
Action< ChatUnmutedNotif >	ChatUnmuted
	Event triggered when user unmuted from group chat.

Member Function Documentation

◆ BanGroupUserChat()

void AccelByte.Api.Chat.BanGroupUserChat	(	string	groupId,
		List< string >	userIds,
		ResultCallback< BanGroupChatResponse >	callback )

inline

Ban users from group chat (used by group moderator).

Parameters

groupId	Id of group from group service.
userIds	List of user ids to ban.
callback	Function callback when operation is done.

◆ BlockUser()

void AccelByte.Api.Chat.BlockUser	(	string	userId,
		ResultCallback< BlockUnblockResponse >	callback )

inline

Block user.

Parameters

userId	user ID to block.
callback	Function callback when operation is done.

◆ CreateGroupTopic() [1/2]

void AccelByte.Api.Chat.CreateGroupTopic	(	string	groupName,
		string[]	adminUserId,
		string[]	memberUserIds,
		CreateGroupTopicOptionalParameter	optionalParameter,
		ResultCallback< ChatActionTopicResponse >	callback )

inline

Create a group topic It can be used to let multiple users connect to each other.

Parameters

groupName	group chat name
adminUserId	list of moderator/admin for this group chat
memberUserIds	list of members for this group chat
callback	Result of this operation
optionalParameter	optional parameter when create a group topic

◆ CreateGroupTopic() [2/2]

void AccelByte.Api.Chat.CreateGroupTopic	(	string	groupName,
		string[]	adminUserId,
		string[]	memberUserIds,
		ResultCallback< ChatActionTopicResponse >	callback )

inline

Create a group topic It can be used to let multiple users connect to each other.

Parameters

groupName	group chat name
adminUserId	list of moderator/admin for this group chat
memberUserIds	list of members for this group chat
callback	Result of this operation

◆ CreatePersonalTopic()

void AccelByte.Api.Chat.CreatePersonalTopic	(	string	otherUserId,
		ResultCallback< ChatActionTopicResponse >	callback )

inline

Create a private topic with other user.

Parameters

otherUserId	other user we want to create a topic with.
callback	Result of this operation.

◆ DeleteGroupChat()

void AccelByte.Api.Chat.DeleteGroupChat	(	string	groupId,
		string	chatId,
		ResultCallback	callback )

inline

Delete a message from group chat (used by group moderator).

Parameters

groupId	Id of group from group service.
chatId	Id of message to delete.
callback	Function callback when operation is done.

◆ DeleteSystemMessages()

void AccelByte.Api.Chat.DeleteSystemMessages	(	HashSet< string >	messageIds,
		ResultCallback< DeleteSystemMessagesResponse >	callback )

inline

Delete system message(s) in user system inbox.

Parameters

messageIds	Array of system message id
callback	Function callback when operation is done.

◆ DeleteTopic()

void AccelByte.Api.Chat.DeleteTopic	(	string	topicId,
		ResultCallback< ChatActionTopicResponse >	callback )

inline

Delete a topic.

Parameters

topicId	topic id to be deleted
callback	Result of this operation

◆ GetGroupChatSnapshot()

void AccelByte.Api.Chat.GetGroupChatSnapshot	(	string	groupId,
		string	chatId,
		ResultCallback< ChatSnapshotResponse >	callback )

inline

Get chat snapshot (used by group moderator).

Parameters

groupId	Id of group from group service.
chatId	Id of message.
callback	Function callback when operation is done.

◆ GetSystemMessagesStats()

void AccelByte.Api.Chat.GetSystemMessagesStats	(	ResultCallback< GetSystemMessageStatsResponse >	callback,
		GetSystemMessageStatsRequest	request = default )

inline

Get system messages stats.

Parameters

callback	Function callback when operation is done.
request	Optional request parameter

◆ GetUserChatConfiguration()

void AccelByte.Api.Chat.GetUserChatConfiguration ( ResultCallback< GetUserChatConfigurationResponse > callback )

inline

Get chat configuration for current user.

Parameters

callback Callback for retrieved chat configuration or error

◆ JoinTopic()

void AccelByte.Api.Chat.JoinTopic	(	string	topicId,
		ResultCallback< ChatActionTopicResponse >	callback )

inline

Join a specific topic id.

Parameters

topicId	topic id to be joined
callback	Result of this operation

◆ MuteGroupUserChat()

void AccelByte.Api.Chat.MuteGroupUserChat	(	string	groupId,
		string	userId,
		int	durationInSeconds,
		ResultCallback	callback )

inline

Mute user from group chat (used by group moderator).

Parameters

groupId	Id of group from group service.
userId	Id of the user to be muted.
durationInSeconds	Duration of mute in seconds.
callback	Function callback when operation is done.

◆ QueryChat()

void AccelByte.Api.Chat.QueryChat	(	string	topicId,
		ResultCallback< QueryChatResponse >	callback,
		int	limit = 20,
		DateTime	lastChatCreatedAt = default(DateTime) )

inline

Query chat messages within a topic.

Parameters

topicId	Topic ID to query.
callback	Function callback when operation is done.
limit	Max returned data count.
lastChatCreatedAt	Oldest message date to fetch.

◆ QueryGroupTopic()

void AccelByte.Api.Chat.QueryGroupTopic	(	string	keyword,
		ResultCallback< QueryTopicResponse >	callback,
		int	offset = 0,
		int	limit = 20 )

inline

Query group topics that user is currently a part of.

Parameters

keyword	Topic name keyword to filter.
callback	Function callback when operation is done.
offset	Page offset based on limit number, start from 0. (ex. offset 1 with limit 20 will give item number 21-40)
limit	Count limit of item returned in one request.

◆ QueryPersonalTopic()

void AccelByte.Api.Chat.QueryPersonalTopic	(	string	keyword,
		ResultCallback< QueryTopicResponse >	callback,
		int	offset = 0,
		int	limit = 20 )

inline

Query personal topics that user is currently a part of.

Parameters

keyword	Topic name keyword to filter.
callback	Function callback when operation is done.
offset	Page offset based on limit number, start from 0. (ex. offset 1 with limit 20 will give item number 21-40)
limit	Count limit of item returned in one request.

◆ QuerySystemMessage()

void AccelByte.Api.Chat.QuerySystemMessage	(	ResultCallback< QuerySystemMessagesResponse >	callback,
		QuerySystemMessageRequest	request = default )

inline

Query system messages in user's system inbox.

Parameters

callback	Function callback when operation is done.
request	Optional request parameter

◆ QueryTopic() [1/2]

void AccelByte.Api.Chat.QueryTopic	(	string	keyword,
		ResultCallback< QueryTopicResponse >	callback,
		int	offset = 0,
		int	limit = 20 )

inline

Query group and personal topics that user is currently a part of.

Parameters

keyword	Topic name keyword to filter.
callback	Function callback when operation is done.
offset	Page offset based on limit number, start from 0. (ex. offset 1 with limit 20 will give item number 21-40)
limit	Count limit of item returned in one request.

◆ QueryTopic() [2/2]

void AccelByte.Api.Chat.QueryTopic	(	string	topicId,
		ResultCallback< QueryTopicByIdResponse >	callback )

inline

Query group and personal topic by topic ID.

Parameters

topicId	Topic ID to search.
callback	Function callback when operation is done.

◆ RefreshToken()

void AccelByte.Api.Chat.RefreshToken	(	string	newToken,
		ResultCallback	callback )

inline

Send a new access token to be used in chat service.

Parameters

newToken	The new token to be used.
callback	Result of this operation.

◆ SendChatMessage()

void AccelByte.Api.Chat.SendChatMessage	(	string	topicId,
		string	message,
		ResultCallback< SendChatResponse >	callback )

inline

Send chat message to a topic.

Parameters

topicId	ID of the topic.
message	Chat message to send.
callback	Function callback when operation is done.

◆ SetUserChatConfiguration()

void AccelByte.Api.Chat.SetUserChatConfiguration	(	bool	isProfanityDisabled,
		ResultCallback< SetUserChatConfigurationResponse >	callback )

inline

Set chat configuration for current user.

Parameters

isProfanityDisabled	Bool config for profanity filter
callback	Callback for successful processing or error

◆ UnbanGroupUserChat()

void AccelByte.Api.Chat.UnbanGroupUserChat	(	string	groupId,
		List< string >	userIds,
		ResultCallback< UnbanGroupChatResponse >	callback )

inline

Unban users from group chat (used by group moderator).

Parameters

groupId	Id of group from group service.
userIds	List of user ids to ban.
callback	Function callback when operation is done.

◆ UnblockUser()

void AccelByte.Api.Chat.UnblockUser	(	string	userId,
		ResultCallback< BlockUnblockResponse >	callback )

inline

Unblock user.

Parameters

userId	user ID to unblock.
callback	Function callback when operation is done.

◆ UnmuteGroupUserChat()

void AccelByte.Api.Chat.UnmuteGroupUserChat	(	string	groupId,
		string	userId,
		ResultCallback	callback )

inline

Unmute user from group chat (used by group moderator).

Parameters

groupId	Id of group from group service.
userId	Id of the user to be muted.
callback	Function callback when operation is done.

◆ UpdateSystemMessages()

void AccelByte.Api.Chat.UpdateSystemMessages	(	HashSet< ActionUpdateSystemMessage >	actionUpdateSystemMessages,
		ResultCallback< UpdateSystemMessagesResponse >	callback )

inline

Update system message(s) in user system inbox.

Parameters

actionUpdateSystemMessages	Array of ActionUpdateSystemMessage containing action to mark read/unread and keep system messages.
callback	Function callback when operation is done.

Public Member Functions

Properties

Events

Member Function Documentation

◆ BanGroupUserChat()

◆ BlockUser()

◆ CreateGroupTopic() [1/2]

◆ CreateGroupTopic() [2/2]

◆ CreatePersonalTopic()

◆ DeleteGroupChat()

◆ DeleteSystemMessages()

◆ DeleteTopic()

◆ GetGroupChatSnapshot()

◆ GetSystemMessagesStats()

◆ GetUserChatConfiguration()

◆ JoinTopic()

◆ MuteGroupUserChat()

◆ QueryChat()

◆ QueryGroupTopic()

◆ QueryPersonalTopic()

◆ QuerySystemMessage()

◆ QueryTopic() [1/2]

◆ QueryTopic() [2/2]

◆ RefreshToken()

◆ SendChatMessage()

◆ SetUserChatConfiguration()

◆ UnbanGroupUserChat()

◆ UnblockUser()

◆ UnmuteGroupUserChat()

◆ UpdateSystemMessages()