ChatSupportService Class

Implementation of chat support service.

Inheritance Hierarchy

System.Object
  CMS.Chat.ChatServiceBase
    CMS.Chat.ChatSupportService

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

Syntax

public class ChatSupportService : ChatServiceBase, 
	IChatSupportService

The ChatSupportService type exposes the following members.

Constructors

	Name	Description
Public method	ChatSupportService

Methods

	Name	Description
Public method	EnterSupport	Joins current CMS user to classic chat as hidden and also sets him as online on support chat.
Protected method	GetChatResponse(ChatResponseStatusEnum)	Builds general chat response with error set to statusCode and message set to default value associated with statusCode. (Inherited from ChatServiceBase.)
Protected method	GetChatResponse(ChatResponseStatusEnum, String)	Builds general chat response with error set to statusCode and message set to statusMessage. (Inherited from ChatServiceBase.)
Protected method	GetChatResponse<TData>(ChatResponseStatusEnum, String, TData)	Builds generic ChatGeneral response with properties set to passed params. (Inherited from ChatServiceBase.)
Protected method	GetOkChatResponse()	Builds general chat response with OK code. (Inherited from ChatServiceBase.)
Protected method	GetOkChatResponse<TData>(TData)	Builds general chat response with OK code and Data set to data. (Inherited from ChatServiceBase.)
Public method	InitiateChatByContactID	Initiates chat with user identified by his ContactID.
Public method	InitiateChatByUserID	Initiates chat with user identified by his UserID.
Public method	LeaveSupport	Leaves support chat.
Public method	SupportLeaveRoom	Leaves room. After this call, new messages in this room will be send to all online supporters.
Public method	SupportPing	Checks for new rooms needing support. Keeps alive (sets LastChecking to now) user on support and classic chat.
Public method	SupportTakeRoom	Takes support room. After this call, new messages in this room won't be send to other users - only to the current one.
Protected method	VerifyChatUserHasAdminRoomRights	Verifies that currently logged in chat user has admin rights for a room. Throws exception in case of failure and does nothing in case of success. (Inherited from ChatServiceBase.)
Protected method	VerifyChatUserHasAllPermissions	Verifies that currently logged in chat user has all of the passed permissions. Throws exception in case of failure and does nothing in case of success. (Inherited from ChatServiceBase.)
Protected method	VerifyChatUserHasAnyPermission	Verifies that currently logged in chat user has at least one of the passed permissions. Throws exception in case of failure and does nothing in case of success. (Inherited from ChatServiceBase.)
Protected method	VerifyChatUserHasPermission	Verifies that currently logged in chat user has specified permission. Throws exception in case of failure and does nothing in case of success. (Inherited from ChatServiceBase.)
Protected method	VerifyChatUserIsLoggedIn	Verifies that chat user is logged in. Throws exception in case of failure and does nothing in case of success. (Inherited from ChatServiceBase.)
Protected method	VerifyChatUserIsOnlineInARoom	Verifies that currently logged in chat user is online in a room. Throws exception in case of failure and does nothing in case of success. (Inherited from ChatServiceBase.)
Protected method	VerifyIPIsNotBanned	Verifies that IP addres which was used to make this request is not banned. Throws exception in case of failure and does nothing in case of success. (Inherited from ChatServiceBase.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Protected property	CurrentChatUserState	Gets ChatUserState of currently logged in chat user. (Inherited from ChatServiceBase.)
Protected property	IsIPBanned	Gets true if current user's IP address is banned and he can not do anything on the chat. (Inherited from ChatServiceBase.)
Protected property	Sites	Shortcut to ChatGlobalData.Instance.Sites (contains cached chat objects (rooms, etc.)). (Inherited from ChatServiceBase.)