ChatRoomUserInfoProvider.CleanOnlineUsersInRooms Method

Removes inactive users from all rooms.

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

Syntax

public static int CleanOnlineUsersInRooms(
	int inactiveForSeconds,
	string leaveSystemMessageFormat,
	ChatMessageTypeEnum leaveSystemMessageType
)

Parameters

inactiveForSeconds

Type: System.Int32
Number of seconds needed for user to be considered as inactive.

leaveSystemMessageFormat

Type: System.String
Format of leave room system message. {nickname} will be replaced with actual user's nickname

leaveSystemMessageType

Type: CMS.Chat.ChatMessageTypeEnum
Type of leave room system message.

Return Value

Type: Int32
Number of cleaned users