IChatService.KickUser Method

Kicks a chat user from a room. Currently logged user must be an admin to kick another user.

Namespace: CMS.Chat
Assembly: CMS.Chat (in CMS.Chat.dll) Version: 12.0.0

Syntax

ChatGeneralResponse KickUser(
	int roomID,
	int chatUserToKickID
)

Parameters

roomID

Type: System.Int32
User will be kicked from this room.

chatUserToKickID

Type: System.Int32
ID of user to kick

Return Value

Type: ChatGeneralResponse
ChatGeneralResponse (code OK if everything went fine)