ChatOnlineUserInfoProvider.CleanOnlineUsers Method

Cleans inactive (not pinging) users.

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

Syntax

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

Parameters

inactiveForSeconds

Type: System.Int32
Seconds of inactivity needed to clean user.

leaveSystemMessageFormat

Type: System.String
Format of system message. Placeholder {nickname} will be replaced by actual user's nickname. If null system message won't be inserted.

leaveSystemMessageType

Type: CMS.Chat.ChatMessageTypeEnum
Type of leave room system message (typically ChatMessageTypeEnum.LeaveRoom)

Return Value

Type: Int32
Number of cleaned users