Click or drag to resize
ChatHelper Class
Helper class for chat.
Inheritance Hierarchy
SystemObject
  CMS.ChatChatHelper

Namespace: CMS.Chat
Assembly: CMS.Chat (in CMS.Chat.dll) Version: 9.0.0
Syntax
C#
public static class ChatHelper

The ChatHelper type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberAreAnonymsAllowedGloballySetting
Gets true, if anonymous users are allowed in chat.
Public propertyStatic memberCreateRoomFloodProtectionIntervalSetting
Create room flooding protection interval. In seconds.
Public propertyStatic memberDaysNeededToDeleteRecordsSetting
Days needed to delete old chat records.
Public propertyStatic memberEnableBBCodeSetting
Enabled BB Code globally setting.
Public propertyStatic memberEnableSmileys
Enabled smileys globally setting.
Public propertyStatic memberEnableSoundLiveChat
Enabled sound in live chat setting.
Public propertyStatic memberEnableSoundSupportChat
Enabled sound in support chat setting.
Public propertyStatic memberFirstLoadMessagesCountSetting
Count of messages loaded on first load.
Public propertyStatic memberForceAnonymUniqueNicknamesSetting
If false, anonymou are allowed to have duplicate nicknames. If true, all nicknames must be uniques.
Public propertyStatic memberGlobalPingIntervalSetting
Global ping (method Ping() on service) interval.
Public propertyStatic memberGuestPrefixSetting
Gets prefix of guest user. Value is taken from settings.
Public propertyStatic memberChangeNicknameFloodProtectionIntervalSetting
Change nickname flooding protection interval. In seconds.
Public propertyStatic memberChatAdministrationPopupWindowUrl
Gets address of support chat popup window opened from Desk.
Public propertyStatic memberIsFloodingProtectionEnabledSetting
Gets true if flooding protection is enabled.
Public propertyStatic memberIsSupportEnabledSetting
Gets true if support chat is enabled.
Public propertyStatic memberIsSupportMailEnabledAndValid
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 propertyStatic memberJoinRoomFloodProtectionIntervalSetting
Join room flooding protection interval. In seconds.
Public propertyStatic memberKickLastingIntervalSetting
Kick lasting interval.
Public propertyStatic memberMaximumMessageLengthSetting
Kick lasting interval.
Public propertyStatic memberPostMessageFloodProtectionIntervalSetting
Post message flooding protection interval. In seconds.
Public propertyStatic memberRedirectURLJoinSetting
Gets redirect URL after join room. Value is taken from settings.
Public propertyStatic memberRedirectURLLeaveSetting
Gets redirect URL after leave room. Value is taken from settings.
Public propertyStatic memberRedirectURLLoginSetting
Gets redirect URL after login chat. Value is taken from settings.
Public propertyStatic memberRedirectURLLogoutSetting
Gets redirect URL after logout chat. Value is taken from settings.
Public propertyStatic memberResolveURLEnabled
Enabled URL resolving in messages setting.
Public propertyStatic memberRoomPingIntervalSetting
Room ping interval.
Public propertyStatic memberSupportLogoutTimeoutSetting
Gets timeout needed to automatically logout user from support chat. Value is taken from settings.
Public propertyStatic memberSupportMailDialogURL
Gets address of offline support form. This is a form which is used to send support requests to mail.
Public propertyStatic memberSupportMessageSendToSetting
Gets the email address where support messages are sent to.
Public propertyStatic memberSupportRoomReleaseTimeoutSetting
Gets number of seconds needed to realease room taken by support engineer. Value is taken from settings.
Public propertyStatic memberTransformationErrors
Gets default errors transformation name. Value is taken from settings.
Public propertyStatic memberTransformationErrorsDeleteAll
Gets default errors delete all transformation name. Value is taken from settings.
Public propertyStatic memberTransformationInitiatedChat
Gets default initiated chat transformation. Value is taken from settings.
Public propertyStatic memberTransformationNotifications
Gets default notification transformation name. Value is taken from settings.
Public propertyStatic memberTransformationOnlineUsers
Gets default online users transformation name. Value is taken from settings.
Public propertyStatic memberTransformationRoomMessages
Gets default messages transformation name. Value is taken from settings.
Public propertyStatic memberTransformationRoomName
Gets default room name transformation name. Value is taken from settings.
Public propertyStatic memberTransformationRooms
Gets default rooms transformation name. Value is taken from settings.
Public propertyStatic memberTransformationRoomUsers
Gets default room users transformation name. Value is taken from settings.
Public propertyStatic memberTransformationSupportRequest
Gets default support request transformation. Value is taken from settings.
Public propertyStatic memberUserLogoutTimeoutSetting
Gets timeout needed to automatically logout chat user. Value is taken from settings.
Public propertyStatic memberWPGroupPagesBy
Number of pages in one group default setting.
Public propertyStatic memberWPInviteModePagingItems
Items per page limit for webparts in invite mode.
Public propertyStatic memberWPInviteModeSearchMode
Items per page limit for webparts in invite mode.
Public propertyStatic memberWPPagingItems
Items per page default setting.
Public propertyStatic memberWPSearchModeMaxUsers
Search mode - response max users default limit.
Public propertyStatic memberWPShowFilterLimit
Show filter limit default setting.
Top
Methods
  NameDescription
Public methodStatic memberGetCMSDeskChatUserField(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 methodStatic memberGetCMSDeskChatUserField(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 methodStatic memberGetDocumentAbsoluteUrl
Gets absolute URL from relative document path (if given path is not empty).
Public methodStatic memberCode exampleGetEnumTEnum, 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 methodStatic memberGetChatRoomWindowURL
Returns chat room window url from global chat settings
Public methodStatic memberGetRoomIdFromQuery
Get room ID from query or return original room ID.
Public methodStatic memberGetWebpartLoadingDiv
Get webpart's loading div which is showed when data are loaded.
Public methodStatic memberGetWebpartTransformation
Get webpart's transformation
Public methodStatic memberHasCurrentUserPermission
Checks if current user (CMSUser) has permission to perform specified chat-related action.
Public methodStatic memberHasUserPermission
Checks if specified user (CMSUser) has permission to perform specified chat-related action.
Public methodStatic memberCheckNameForBadWords
Throws ChatBadWordsException if there are some bad words in name.
Public methodStatic memberCheckOperationForFlooding
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 methodStatic memberIsSupportChatPanelEnabled
Adds Support box to the passed panel. It should be called in SiteManager's and CMSDesk's Page_Load.
Public methodStatic memberLogChatActivity(ChatActivityTypeEnum)
Logs activity with type specified by activityType. Title is empty.
Public methodStatic memberLogChatActivity(ChatActivityTypeEnum, String)
Logs activity with type specified by activityType. Title is set to
Public methodStatic memberRegisterChatAJAXProxy
Registers AJAX proxy which can be used to call ChatService.svc from javascript.
Public methodStatic memberRegisterChatManager
Registers ChatManager.js and support scripts.
Public methodStatic memberRegisterChatNotificationManager
Registers Chat sound manager used for playing sound notifications.
Public methodStatic memberRegisterChatSupportAJAXProxy
Registers AJAX proxy which can be used to call ChatSupportService.svc from javascript.
Public methodStatic memberRegisterChatSupportManager
Registers ChatSupportManager and support scripts.
Public methodStatic memberRegisterStylesheet(Page)
Registers CSS stylesheet. If page inherits CMSChatPage, CMSDesk stylesheet will be used instead of livesite stylesheet.
Public methodStatic memberRegisterStylesheet(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.
Top
See Also