Click or drag to resize
ChatRoomUserInfoProviderCleanOnlineUsersInRooms Method
Removes inactive users from all rooms.

Namespace: CMS.Chat
Assembly: CMS.Chat (in CMS.Chat.dll) Version: 12.0.0
Syntax
C#
public static int CleanOnlineUsersInRooms(
	int inactiveForSeconds,
	string leaveSystemMessageFormat,
	ChatMessageTypeEnum leaveSystemMessageType
)

Parameters

inactiveForSeconds
Type: SystemInt32
Number of seconds needed for user to be considered as inactive.
leaveSystemMessageFormat
Type: SystemString
Format of leave room system message. {nickname} will be replaced with actual user's nickname
leaveSystemMessageType
Type: CMS.ChatChatMessageTypeEnum
Type of leave room system message.

Return Value

Type: Int32
Number of cleaned users
See Also