ChatServiceBase Class

Base class of all chat web services.

Inheritance Hierarchy

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

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

Syntax

public class ChatServiceBase

The ChatServiceBase type exposes the following members.

Constructors

	Name	Description
Public method	ChatServiceBase	Constructor.

Methods

	Name	Description
Protected method	GetChatResponse(ChatResponseStatusEnum)	Builds general chat response with error set to statusCode and message set to default value associated with statusCode.
Protected method	GetChatResponse(ChatResponseStatusEnum, String)	Builds general chat response with error set to statusCode and message set to statusMessage.
Protected method	GetChatResponse<TData>(ChatResponseStatusEnum)	Builds chat response with code set to statusCode, message set to default value associated with statusCode and data set to default(TData).
Protected method	GetChatResponse<TData>(ChatResponseStatusEnum, String)	Builds chat response with code set to statusCode, message set to statusMessage and data set to default(TData).
Protected method	GetChatResponse<TData>(ChatResponseStatusEnum, String, TData)	Builds generic ChatGeneral response with properties set to passed params.
Protected method	GetOkChatResponse()	Builds general chat response with OK code.
Protected method	GetOkChatResponse<TData>(TData)	Builds general chat response with OK code and Data set to data.
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.
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.
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.
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.
Protected method	VerifyChatUserIsLoggedIn	Verifies that chat user is logged in. Throws exception in case of failure and does nothing in case of success.
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.
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.

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.
Protected property	IsIPBanned	Gets true if current user's IP address is banned and he can not do anything on the chat.
Protected property	Sites	Shortcut to ChatGlobalData.Instance.Sites (contains cached chat objects (rooms, etc.)).