ChatOnlineUserInfoProvider.Logout Method

Logouts user from chat. User is also removed from all rooms where he is online now. Leave room system message is inserted to this room. Does nothing if this online user does not exists.

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

Syntax

public static void Logout(
	int siteID,
	int chatUserID,
	string leaveSystemMessageFormat,
	Nullable<ChatMessageTypeEnum> leaveSystemMessageType
)

Parameters

siteID

Type: System.Int32
Site ID

chatUserID

Type: System.Int32
Chat user ID

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: System.Nullable<ChatMessageTypeEnum>
Type of leave room system message (typically ChatMessageTypeEnum.LeaveRoom)