ChatRoomUserInfoProviderLeaveRoom 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.ChatAssembly: CMS.Chat (in CMS.Chat.dll) Version: 10.0.0
Syntaxpublic static void LeaveRoom(
int roomID,
int chatUserID,
string leaveSystemMessageFormat,
Nullable<ChatMessageTypeEnum> leaveSystemMessageType
)
Parameters
- roomID
- Type: SystemInt32
User will be left from this room - chatUserID
- Type: SystemInt32
Chat user ID - leaveSystemMessageFormat
- Type: SystemString
Format of system message. Placeholder {nickname} will be replaced by actual user's nickname. If null system message won't be inserted. - leaveSystemMessageType
- Type: SystemNullableChatMessageTypeEnum
Type of leave room system message (typically ChatMessageTypeEnum.LeaveRoom)
See Also