ChatHelper Class

Helper class for chat.

Inheritance Hierarchy

System.Object
  CMS.Chat.ChatHelper

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

Syntax

public static class ChatHelper

The ChatHelper type exposes the following members.

Properties

	Name	Description
Public property Static member	AreAnonymsAllowedGloballySetting	Gets true, if anonymous users are allowed in chat.
Public property Static member	CreateRoomFloodProtectionIntervalSetting	Create room flooding protection interval. In seconds.
Public property Static member	DaysNeededToDeleteRecordsSetting	Days needed to delete old chat records.
Public property Static member	EnableBBCodeSetting	Enabled BB Code globally setting.
Public property Static member	EnableSmileys	Enabled smileys globally setting.
Public property Static member	EnableSoundLiveChat	Enabled sound in live chat setting.
Public property Static member	EnableSoundSupportChat	Enabled sound in support chat setting.
Public property Static member	FirstLoadMessagesCountSetting	Count of messages loaded on first load.
Public property Static member	ForceAnonymUniqueNicknamesSetting	If false, anonymou are allowed to have duplicate nicknames. If true, all nicknames must be uniques.
Public property Static member	GlobalPingIntervalSetting	Global ping (method Ping() on service) interval.
Public property Static member	GuestPrefixSetting	Gets prefix of guest user. Value is taken from settings.
Public property Static member	ChangeNicknameFloodProtectionIntervalSetting	Change nickname flooding protection interval. In seconds.
Public property Static member	ChatAdministrationPopupWindowUrl	Gets address of support chat popup window opened from Desk.
Public property Static member	IsFloodingProtectionEnabledSetting	Gets true if flooding protection is enabled.
Public property Static member	IsSupportEnabledSetting	Gets true if support chat is enabled.
Public property Static member	IsSupportMailEnabledAndValid	Gets true if sending support requests to mail is enabled and addresses (from and to) are valid emails. Only lenght of those addresses are checked because validity is handled by Settings validation regex in Site manager.
Public property Static member	JoinRoomFloodProtectionIntervalSetting	Join room flooding protection interval. In seconds.
Public property Static member	KickLastingIntervalSetting	Kick lasting interval.
Public property Static member	MaximumMessageLengthSetting	Kick lasting interval.
Public property Static member	PostMessageFloodProtectionIntervalSetting	Post message flooding protection interval. In seconds.
Public property Static member	RedirectURLJoinSetting	Gets redirect URL after join room. Value is taken from settings.
Public property Static member	RedirectURLLeaveSetting	Gets redirect URL after leave room. Value is taken from settings.
Public property Static member	RedirectURLLoginSetting	Gets redirect URL after login chat. Value is taken from settings.
Public property Static member	RedirectURLLogoutSetting	Gets redirect URL after logout chat. Value is taken from settings.
Public property Static member	ResolveURLEnabled	Enabled URL resolving in messages setting.
Public property Static member	RoomPingIntervalSetting	Room ping interval.
Public property Static member	SupportLogoutTimeoutSetting	Gets timeout needed to automatically logout user from support chat. Value is taken from settings.
Public property Static member	SupportMailDialogURL	Gets address of offline support form. This is a form which is used to send support requests to mail.
Public property Static member	SupportMessageSendToSetting	Gets the email address where support messages are sent to.
Public property Static member	SupportRoomReleaseTimeoutSetting	Gets number of seconds needed to realease room taken by support engineer. Value is taken from settings.
Public property Static member	TransformationErrors	Gets default errors transformation name. Value is taken from settings.
Public property Static member	TransformationErrorsDeleteAll	Gets default errors delete all transformation name. Value is taken from settings.
Public property Static member	TransformationInitiatedChat	Gets default initiated chat transformation. Value is taken from settings.
Public property Static member	TransformationNotifications	Gets default notification transformation name. Value is taken from settings.
Public property Static member	TransformationOnlineUsers	Gets default online users transformation name. Value is taken from settings.
Public property Static member	TransformationRoomMessages	Gets default messages transformation name. Value is taken from settings.
Public property Static member	TransformationRoomName	Gets default room name transformation name. Value is taken from settings.
Public property Static member	TransformationRooms	Gets default rooms transformation name. Value is taken from settings.
Public property Static member	TransformationRoomUsers	Gets default room users transformation name. Value is taken from settings.
Public property Static member	TransformationSupportRequest	Gets default support request transformation. Value is taken from settings.
Public property Static member	UserLogoutTimeoutSetting	Gets timeout needed to automatically logout chat user. Value is taken from settings.
Public property Static member	WPGroupPagesBy	Number of pages in one group default setting.
Public property Static member	WPInviteModePagingItems	Items per page limit for webparts in invite mode.
Public property Static member	WPInviteModeSearchMode	Items per page limit for webparts in invite mode.
Public property Static member	WPPagingItems	Items per page default setting.
Public property Static member	WPSearchModeMaxUsers	Search mode - response max users default limit.
Public property Static member	WPShowFilterLimit	Show filter limit default setting.

Methods

	Name	Description
Public method Static member	GetCMSDeskChatUserField(Control, ChatUserInfo)	Gets string representation which can be used to display chat user in CMS Desk. If user is not anonymous, returned string is a HTML code which contains anchor to open user's details in new window. If user is anonymous, returned string will be simply his nickname. Nickname will be always HTML encoded.
Public method Static member	GetCMSDeskChatUserField(Control, Int32, String, Boolean)	Gets string representation which can be used to display chat user in CMS Desk. If user is not anonymous, returned string is a HTML code which contains anchor to open user's details in new window. If user is anonymous, returned string will be simply his nickname. Nickname will be always HTML encoded.
Public method Static member	GetDocumentAbsoluteUrl	Gets absolute URL from relative document path (if given path is not empty).
Public method Static member Code example	GetEnum<TEnum, TUnderlayingType>	Gets Enum from its underlying type. If the specified value doesn't have its representation in the enum, defaultValue is returned. Exception is thrown if TEnum is not Enum.
Public method Static member	GetChatRoomWindowURL	Returns chat room window url from global chat settings
Public method Static member	GetRoomIdFromQuery	Get room ID from query or return original room ID.
Public method Static member	GetWebpartLoadingDiv	Get webpart's loading div which is showed when data are loaded.
Public method Static member	GetWebpartTransformation	Get webpart's transformation
Public method Static member	HasCurrentUserPermission	Checks if current user (CMSUser) has permission to perform specified chat-related action.
Public method Static member	HasUserPermission	Checks if specified user (CMSUser) has permission to perform specified chat-related action.
Public method Static member	CheckNameForBadWords	Throws ChatBadWordsException if there are some bad words in name.
Public method Static member	CheckOperationForFlooding	Checks if specified operation happened to early after the previous call. If it happened to early (earlier than timespan specified in settings), it is considered as flooding and operation should be stopped.
Public method Static member	IsSupportChatPanelEnabled	Adds Support box to the passed panel. It should be called in SiteManager's and CMSDesk's Page_Load.
Public method Static member	LogChatActivity(ChatActivityTypeEnum)	Logs activity with type specified by activityType. Title is empty.
Public method Static member	LogChatActivity(ChatActivityTypeEnum, String)	Logs activity with type specified by activityType. Title is set to
Public method Static member	RegisterChatAJAXProxy	Registers AJAX proxy which can be used to call ChatService.svc from javascript.
Public method Static member	RegisterChatManager	Registers ChatManager.js and support scripts.
Public method Static member	RegisterChatNotificationManager	Registers Chat sound manager used for playing sound notifications.
Public method Static member	RegisterChatSupportAJAXProxy	Registers AJAX proxy which can be used to call ChatSupportService.svc from javascript.
Public method Static member	RegisterChatSupportManager	Registers ChatSupportManager and support scripts.
Public method Static member	RegisterStylesheet(Page)	Registers CSS stylesheet. If page inherits CMSChatPage, CMSDesk stylesheet will be used instead of livesite stylesheet.
Public method Static member	RegisterStylesheet(Page, Boolean)	Registers CSS stylesheet. If cmsDeskStyle is true, CMSDesk stylesheet will be used instead of livesite stylesheet. The CMS desk stylesheet is bootstrap for support dialog, old css otherwise.