The ChatSupportService type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | ChatSupportService |
Methods
| Name | Description | |
|---|---|---|
| EnterSupport |
Joins current CMS user to classic chat as hidden and also sets him as online on support chat.
|
|  Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetChatResponse(ChatResponseStatusEnum) |
Builds general chat response with error set to statusCode and message set to default value associated with statusCode.
(Inherited from ChatServiceBase.) |
| GetChatResponse(ChatResponseStatusEnum, String) |
Builds general chat response with error set to statusCode and message set to statusMessage.
(Inherited from ChatServiceBase.) |
| GetChatResponse TData (ChatResponseStatusEnum, String, TData) |
Builds generic ChatGeneral response with properties set to passed params.
(Inherited from ChatServiceBase.) |
| GetOkChatResponse |
Builds general chat response with OK code.
(Inherited from ChatServiceBase.) |
| GetOkChatResponse TData (TData) |
Builds general chat response with OK code and Data set to data.
(Inherited from ChatServiceBase.) |
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| InitiateChatByContactID |
Initiates chat with user identified by his ContactID.
|
| InitiateChatByUserID |
Initiates chat with user identified by his UserID.
|
| LeaveSupport |
Leaves support chat.
|
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| SupportLeaveRoom |
Leaves room. After this call, new messages in this room will be send to all online supporters.
|
| SupportPing |
Checks for new rooms needing support.
Keeps alive (sets LastChecking to now) user on support and classic chat.
|
| SupportTakeRoom |
Takes support room. After this call, new messages in this room won't be send to other users - only to the current one.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| 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.) |
| 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.) |
| 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.) |
| 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.) |
| VerifyChatUserIsLoggedIn |
Verifies that chat user is logged in.
Throws exception in case of failure and does nothing in case of success.
(Inherited from ChatServiceBase.) |
| 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.) |
| 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 | |
|---|---|---|
 | GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Properties
| Name | Description | |
|---|---|---|
 | CurrentChatUserState |
Gets ChatUserState of currently logged in chat user.
(Inherited from ChatServiceBase.) |
| IsIPBanned |
Gets true if current user's IP address is banned and he can not do anything on the chat.
(Inherited from ChatServiceBase.) |
| Sites |
Shortcut to ChatGlobalData.Instance.Sites (contains cached chat objects (rooms, etc.)).
(Inherited from ChatServiceBase.) |
See Also