ChatServiceBase MembersKentico 8.0 API Reference
The ChatServiceBase type exposes the following members.
Constructors

  NameDescription
Public methodChatServiceBase
Constructor.
Back to Top
Methods

  NameDescription
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Protected methodGetChatResponse(ChatResponseStatusEnum)
Builds general chat response with error set to statusCode and message set to default value associated with statusCode.
Protected methodGetChatResponse(ChatResponseStatusEnum, String)
Builds general chat response with error set to statusCode and message set to statusMessage.
Protected methodGetChatResponse 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 methodGetChatResponse TData (ChatResponseStatusEnum, String)
Builds chat response with code set to statusCode, message set to statusMessage and data set to default(TData).
Protected methodGetChatResponse TData (ChatResponseStatusEnum, String, TData)
Builds generic ChatGeneral response with properties set to passed params.
Protected methodGetOkChatResponse 
Builds general chat response with OK code.
Protected methodGetOkChatResponse TData (TData)
Builds general chat response with OK code and Data set to data.
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Protected methodVerifyChatUserHasAdminRoomRights
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 methodVerifyChatUserHasAllPermissions
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 methodVerifyChatUserHasAnyPermission
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 methodVerifyChatUserHasPermission
Verifies that currently logged in chat user has specified permission. Throws exception in case of failure and does nothing in case of success.
Protected methodVerifyChatUserIsLoggedIn
Verifies that chat user is logged in. Throws exception in case of failure and does nothing in case of success.
Protected methodVerifyChatUserIsOnlineInARoom
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 methodVerifyIPIsNotBanned
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.
Back to Top
Extension Methods

  NameDescription
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Properties

  NameDescription
Protected propertyCurrentChatUserState
Gets ChatUserState of currently logged in chat user.
Protected propertyIsIPBanned
Gets true if current user's IP address is banned and he can not do anything on the chat.
Protected propertySites
Shortcut to ChatGlobalData.Instance.Sites (contains cached chat objects (rooms, etc.)).
Back to Top
See Also