CMS.Chat Namespace |
Class | Description | |
---|---|---|
DeletedRecords |
Class holding information about number of records deleted by scheduled task 'Delete old chat records'
| |
DeletedRoomsCleaner |
Scheduled task which cleans rooms marked for deletion.
| |
EnumExtensionMethods |
Enum extension methods which works with StringValueAttribute and KeyStringValueAttribute.
| |
GlobalSites |
Class holding all sites (SiteStates) installed on this instance of Kentico and being used by chat (site has to be requested at least once to be appear in memory).
| |
ChatBadWordsException |
Exception which is thrown when some user submitted text contains bad words
| |
ChatCacheBeacon |
This class uses cache to control timeouts of other cached items.
It does not store any data itself.
It allows to invalidate caches across web farms (that's the reason why cache is used here - touching cache is propagated across web farms) or only locally.
| |
ChatCacheDictionaryWrapperTKey, TValue |
This class stores cached objects in dictionary and allows to get/invalidate them individually.
| |
ChatCacheWrapperTData |
This class wraps cached data and handles loading on background.
It is designed to be used as a static field.
| |
ChatCurrentStateCacheWrapperTData, TKey |
This cache wrapper holds Dictionary of items called 'current state', which is bascically an key-value collection of items.
Items in this collections can be modified by FetchChangedDataFunc.
It takes two functions:
FetchAllDataFunc - this function is used to load initial current state
FetchChangedDataFunc - this function is used to load changes to current state in time
| |
ChatCurrentStateCacheWrapperTData, TKeyCurrentStateCacheWrapperDataTKeyInner, TDataInner |
Internal representation of data stored in ChatCurrentStateCacheWrapper. It contains dictionary of TData indexed by TKey.
| |
ChatFloodProtector |
Chat flood protector. Holds info about last actions in memory -> works only in one-server solution.
| |
ChatGeneralResponse |
Chat general response without payload with data.
| |
ChatGeneralResponseTData |
Chat general response with payload.
| |
ChatGlobalData |
Singleton class which holds data needed by chat. It contains instances of other classes to split responsibilities between classes.
| |
ChatHelper |
Helper class for chat.
| |
ChatIncrementalCacheWithCurrentStateWrapperTData, TPrimaryKey |
This cache wrapper combines CurrentStateWrapper and ParametrizedCacheWrapper. Where parametrized cache wrapper takes
only one argument - DateTime. This argument is automatically wrapped in IChatCacheableParam.
| |
ChatInitiatedChatRequestHelper |
Helper class for initiated chat.
| |
ChatInitiatedChatRequestInfo |
ChatInitiatedChatRequestInfo data container class.
| |
ChatInitiatedChatRequestInfoProvider |
Class providing ChatInitiatedChatRequestInfo management.
| |
ChatMessageHelper |
Helper class for chat messages.
| |
ChatMessageInfo |
ChatMessageInfo data container class.
| |
ChatMessageInfoProvider |
Class providing ChatMessageInfo management.
| |
ChatMessageTypeEnumExtensionMethods |
ChatMessageTypeEnum extension methods.
| |
ChatModule |
Represents the Chat module.
| |
ChatModuleMetadata |
Represents the Chat module metadata.
| |
ChatNotificationData |
Info about one notification.
| |
ChatNotificationHelper |
Helper class for chat notifications.
| |
ChatNotificationInfo |
ChatNotificationInfo data container class.
| |
ChatNotificationInfoProvider |
Class providing ChatNotificationInfo management.
| |
ChatNotificationsData |
Chat notifications data.
| |
ChatOnlineSupportHelper |
Helper class for online support.
| |
ChatOnlineSupportInfo |
ChatOnlineSupportInfo data container class.
| |
ChatOnlineSupportInfoProvider |
Class providing ChatOnlineSupportInfo management.
| |
ChatOnlineUserHelper |
Helper class for chat online users.
| |
ChatOnlineUserInfo |
ChatOnlineUser data container class.
| |
ChatOnlineUserInfoProvider |
Class providing ChatOnlineUser management.
| |
ChatOnlineUsersCleaner |
Scheduled task which cleans inactive chat users and supporters.
| |
ChatParametrizedCacheWrapperTData, TParam |
This class represents parametrized cache. This is cache which takes params in form of IChatCacheableParam, makes
hash code from this param (CacheKey) and if this key exists in cache, it returns cache. If key does not exists,
it uses function of type FetchDataFunc to get data and store them in cache.
Function FetchDataFunc returns IEnumerable. This means that this cache is useful only for sequences.
| |
ChatPopupWindowSettingsHelper |
Helper class for managing ChatPopupWindowSettings.
| |
ChatPopupWindowSettingsInfo |
ChatPopupWindowSettings data container class.
| |
ChatPopupWindowSettingsInfoProvider |
Class providing ChatPopupWindowSettings management.
| |
ChatRoomData |
Info about chat room.
| |
ChatRoomHelper |
Helper class. Contains methods working only with chat rooms.
| |
ChatRoomInfo |
ChatRoomInfo data container class.
| |
ChatRoomInfoProvider |
Class providing ChatRoomInfo management.
| |
ChatRoomsData |
Data about chat rooms.
| |
ChatRoomUserHelper |
Helper class for managing chat users in rooms (ChatRoomUserInfo).
| |
ChatRoomUserInfo |
ChatRoomUser data container class.
| |
ChatRoomUserInfoProvider |
Class providing ChatRoomUser management.
| |
ChatService |
Implementation of chat service. All chat operations made from client goes through this service.
| |
ChatServiceBase |
Base class of all chat web services.
| |
ChatServiceException |
Exception used to pass status code and status message to the service.
| |
ChatSettingsHandler |
ASP.NET handler for generating chat settings.
| |
ChatSupportCannedResponseInfo |
ChatSupportCannedResponseInfo data container class.
| |
ChatSupportCannedResponseInfoProvider |
Class providing ChatSupportCannedResponseInfo management.
| |
ChatSupportService |
Implementation of chat support service.
| |
ChatSupportTakenRoomHelper |
Helper class for Chat_SupportTakenRoom.
| |
ChatSupportTakenRoomInfo |
ChatSupportTakenRoomsInfo data container class.
| |
ChatSupportTakenRoomInfoProvider |
Class providing ChatSupportTakenRoomsInfo management.
| |
ChatUserHelper |
Helper class specific for chat user.
| |
ChatUserInfo |
ChatUserInfo data container class.
| |
ChatUserInfoProvider |
Class providing ChatUserInfo management.
| |
ChatUserPermissionData |
Chat user permissions data.
| |
ChatUserStateData |
State of chat user.
| |
InitiatedChats |
This class holds initiated chat requests in cache. There are two caches grouped by UserID and ContactID, so checking for
request is fast.
Cache invalidates itself after certain amount of time (no manual invalidation).
| |
InitiateChatRequestData |
Data class containing information about chat request. This class is send to client.
| |
JoinRoomData |
Class returned by JoinRoom operation.
| |
KeyStringValueAttribute |
This attribute is used to represent a string value of an enum elements.
Unlike StringValueAttribute, this attribute can be used multiple times. Which attribute should be used will be specified by key.
Key can't be generic (C# limitation) nor Enum (Attribute params can not be dynamic). Thus it is int.
| |
KickedUsers |
Class holding kicked users. It should be stored in cache.
| |
MessageCacheParams |
Params for getting messages from database. Those params have to be wrapped in class to be usable by ChatParametrizedCacheWrapper.
| |
MessageData |
Chat message.
| |
MessagesData |
Data about messages in a room.
| |
OldInitiatedChatRequestsCleaner |
Sheduled task which cleans old, unused chat records (rooms, messages, users). Setting how old data should be cleaned is in Settings.
| |
OldRecordsCleaner |
Sheduled task which cleans old, unused chat records (rooms, messages, users). Setting how old data should be cleaned is in Settings.
| |
OnlineSupport |
Class holding cache of users online on support.
| |
OnlineUserData |
Online user data.
| |
OnlineUsersCountData |
Info about counts of users in room.
| |
OnlineUsersData |
Data about online users.
| |
PingResultData |
Response of Ping.
| |
PingRoomResponseData |
State of a room (response to PingRoom).
| |
RoomAdminState |
Admin state of one user in one room.
| |
RoomOnlineUserData |
Data about one online user in a room.
| |
RoomOnlineUsersData |
Info about online users in a room.
| |
RoomState |
Class holding caches of messages and online users in one room.
| |
SiteOnlineUsers |
Class holding cached online users and notification (only times) on one site.
| |
SiteRooms |
This class holds rooms (RoomStates) for site.
| |
SiteRoomsOnlineUsersCounts |
Class holding counts of online users in rooms.
| |
SiteState |
Class holds four helper classes (rooms, online users, online supporters and messages in support rooms) and provide accessors for them.
| |
StringValueAttribute |
This attribute is used to represent a string value of an enum elements.
There can be only one StringValue attribute on an enum value.
It supports automatic resource string translation (IsResourceString property).
| |
SupportOfflineMessageHelper |
Helper class for support requests when no support is online.
| |
SupportPingResponseData |
Response of support Ping.
| |
SupportRoom |
Class storing information about room which has some pending messages needed support. This class is intended to be retrieved from DB and stored in chache.
| |
SupportRoomData |
Data about support room.
| |
SupportRooms |
This class stores cache of SupportRoom (rooms needed support). Those rooms are stored in cache under the key which is time of last change.
| |
SupportRoomsData |
Data about support rooms.
| |
SystemMessageAttribute |
This attribute is used to distinguish system messages vs. classic (user submitted) messages.
| |
UserRoomAdminState |
This class holds information about admin states of one user.
| |
UsersInRoomsCountsData |
Counts of users in all accesible or changed rooms.
| |
UsersRoomAdminStates |
Upper class for storing information about admin rights of users in rooms.
Information are stored in a hierarchy:
UsersRoomAdminStates has dictionary indexed by ints - those are chat user IDs. Values are UserRoomAdminState.
UserRoomAdminStates has dictionary indexed by ints - those are room IDs. Values are RoomAdminState - admin state in room.
|
Interface | Description | |
---|---|---|
ICacheWrapperResponseTData |
This interface is returned from Chat cache wrappers when collection of items and its last modification time are needed.
| |
IChatCacheableParam |
Parametrized cache accepts this interface as a parameter.
| |
IChatCacheableWithCurrentStateTKey |
Items cached in CurrentStateCache has to implement this interface.
| |
IChatIncrementalCacheable |
Only classes which implement this interface can be stored in ChatParametrizedCacheWrapper.
| |
IChatService |
Service contract for chat service.
| |
IChatSupportService |
Service contract for ChatSupportService.
|
Delegate | Description | |
---|---|---|
FetchAllDataFuncTData |
Function which returns all data in CurrentStateCacheWrapper. This function is used to load initial data. Then
FetchChangedDataFunc is used to update current state.
| |
FetchDataFuncTData, TParam |
Function to return data for ChatParametrizedCacheWrapper. It takes IChatCacheableParam as parameter.
| |
FetchChangedDataFuncTData |
This function returns changed data.
|
Enumeration | Description | |
---|---|---|
AdminLevelEnum |
Possible admin levels of chat user in room.
| |
FloodOperationEnum |
Operations which are checked for flooding.
| |
ChangeTypeEnum |
Change type of cacheable item.
| |
ChatActivityTypeEnum |
Activity types related to chat.
| |
ChatMessageTypeEnum |
Types of chat system messages.
IsResourceString is left to false in StringValueType.LiveSiteMessage, because it is resolved manually later.
[SystemMessage] attribute must be added to all system messages to distinguish them from non-system (posted by user) messages.
| |
ChatMessageTypeStringValueUsageEnum |
Usage of string value attribute in ChatMessageTypeEnum.
| |
ChatNotificationTypeEnum |
Types of chat notifications.
| |
ChatPermissionEnum |
Enum of chat permissions.
| |
ChatResponseStatusEnum |
ChatService response codes.
| |
ChatRoomMessagesDirectionEnum |
Directions for chat room messages window
| |
InitiatedChatRequestStateEnum |
State of initiated chat request.
| |
JoinRoomResultEnum |
Possible results from JoinRoom operations.
|