ChatRoomUserInfoProvider.LeaveRoom Method

User leaves room. Sets his JoinTime to null, LeaveTime to now, LastModification to now. Etc. This method also inserts system message about leaving to this room.

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

Syntax

public static void LeaveRoom(
	int roomID,
	int chatUserID,
	string leaveSystemMessageFormat,
	Nullable<ChatMessageTypeEnum> leaveSystemMessageType
)

Parameters

roomID

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

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)