ChatUserHelper Class

Helper class specific for chat user.

Inheritance Hierarchy

System.Object
  CMS.Chat.ChatUserHelper

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

Syntax

public static class ChatUserHelper

The ChatUserHelper type exposes the following members.

Methods

	Name	Description
Public method Static member	GetChatUserFromCMSUser()	Gets chat user assigned to CURRENT CMSUser. If chat user does not exist, it is created with nickname set to FullName of CMSUser.
Public method Static member	GetChatUserFromCMSUser(UserInfo)	Gets chat user assigned to passed CMSUser. If chat user does not exist, it is created with nickname set to FullName of CMSUser.
Public method Static member	HasChatUserPermission	Checks if chat user has permission.
Public method Static member	ChangeChatUserNickname	Changes nickname of passed chatUser.
Public method Static member	CheckAdminRoomRights(Int32)	Check if current user has admin rights to room. User have admin rights if one of the following conditions is valid: - he is global admin - he has permission ChatPermissionEnum.ManageRooms - he is creator of this room - he is associated as admin to this room in table ChatRoomAdmin - room is support (ChatRoomIsSupport = true) and user has permission ChatPermissionEnum.EnterSupport
Public method Static member	CheckAdminRoomRights(Int32, ChatUserInfo)	Check if user has admin rights to room. User have admin rights if one of the following conditions is valid: - he is global admin - he has permission ChatPermissionEnum.ManageRooms - he is creator of this room - he is associated as admin to this room in table ChatRoomAdmin - room is support (ChatRoomIsSupport = true) and user has permission ChatPermissionEnum.EnterSupport
Public method Static member	CheckJoinRoomRights	Checks if current chat user has Join rights to the specified room. - user can't be kicked - if room is public, user always has Join rights - if he is admin, he also has join rights - supporters always have Join rights in support rooms
Public method Static member	IsNicknameAvailable(String)	Returns true if nickname is available. Otherwise false. Takes into account ChatHelper.ForceAnonymUniqueNicknamesSetting.
Public method Static member	IsNicknameAvailable(String, Boolean)	Returns true if nickname is available. Otherwise false. Current user is not counted.
Public method Static member	RegisterAndLoginChatUser()	Registers guest chat user. His nickame is generated automatically. If CMS User is logged in, guest is not registered and this CMS User is logged in.
Public method Static member	RegisterAndLoginChatUser(Boolean)	Registers guest chat user. His nickame is generated automatically. If CMS User is logged in, guest is not registered and this CMS User is logged in.
Public method Static member	RegisterAndLoginChatUser(String)	If CMS User is currently logged in, it logs him into chat. Parameter nickname is ignored in that case. If CMS User is not logged in, user is registered as anonymous chat user with nickname set to parameter nickname. Does nothing if chat user is currently logged in.
Public method Static member	RegisterAndLoginChatUser(String, Boolean)	If CMS User is currently logged in, it logs him into chat. Parameter nickname is ignored in that case. If CMS User is not logged in, user is registered as anonymous chat user with nickname set to parameter nickname. Does nothing if chat user is currently logged in.
Public method Static member	RegisterAnonymousChatUser	Registers anonym chat user with specified nickname.
Public method Static member	VerifyChatUserHasJoinRoomRights	Verifies that currently logged in chat user has join rights for a room. Throws exception with AccessDenied (or Kicked) type and message set to the cause of the denial in case of failure and does nothing in case of success. Join rights: - user can't be kicked - if room is public, user always has Join rights - if he is admin, he also has join rights - supporters always have Join rights in support rooms
Public method Static member	VerifyNicknameIsValid	Checks if nickname is valid. Nickname is also trimmed. Nickname cannot be empty Nickname cannot exceed 50 characters User can't manually change his nickname to guest nickname Throws exception if not valid