ChatService Class

Implementation of chat service. All chat operations made from client goes through this service.

Inheritance Hierarchy

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

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

Syntax

public class ChatService : ChatServiceBase, 
	IChatService

The ChatService type exposes the following members.

Constructors

	Name	Description
Public method	ChatService

Methods

	Name	Description
Public method	AcceptChatRequest	Accepts initiated chat request.
Public method	AcceptInvitation	Accepts invitation: - closes specified notification - inserts user into room (joins) - sends notification to sender about accepting invite
Public method	AddAdmin	Adds admin to the room. Only admin can do it.
Public method	CloseAllNotifications	Closes (markes as read) all notifications which belongs to online users and which were sent until untilWhen.
Public method	CloseNotification	Closes (markes as read) specified notification. This can be used to close generic notifications like InvitationDeclined or InvitationAccepted.
Public method	CreateChatRoom	Creates new chat room. Current user have to join it manually after creating it. Code name of this room will be: chatroom_{current_user_id}_{new_guid}
Public method	CreateOneToOneChatRoom	Creates new one-to-one chat room which will be accessible by current user and one more user (invited one). Display name of new room will be: {nickname_current} - {nickname_invited} Code name will be: adhoc_{id_lower}-{id_upper} ({id_lower} is the lower id of the two chat users, {id_upper} is the upper one). A current user have to manually join this room after creating it. If those two users have chatted before, the previously created room is returned. Code name is used to find previously created chat room.
Public method	CreateSupportChatRoom	Creates new support room. Support room is private room which can be accessed only by creator and support. When creator writes to this room, support is notified.
Public method	CreateSupportChatRoomManual	Creates new support room. Support room is private room which can be accessed only by creator and support. When creator writes to this room, support is notified. This room does not have default greeting message, but messages passed as parameter.
Public method	DeclineChatRequest	Declines initiated chat request.
Public method	DeclineInvitation	Declines invitation: - closes specified notification - sends notification to sender about declining invite
Public method	DeleteAdmin	Deletes admin from the room. Only admin can do it.
Public method	DeleteChatRoom	Disables room. User has to be either Global admin, has ManageRooms permission or be creator/admin of this room.
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.)
Public method	GetChatUserState	Gets info about currently logged in chat user.
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	GetPermissions	Gets permissions of currently logged in user.
Public method	GetSupportEngineersOnlineCount	Gets count of currently logged in support engineers.
Public method	ChangeChatRoom	Changes existing chat room.
Public method	ChangeMyNickname	Changes nickname of currently logged in user.
Public method	InviteToRoom	Invites user to the chat room. Invitation is inserted into the second user's notifications. Second user can enter the room after accepting the invitation. Current user has to have admin rights to the room to invite.
Public method	JoinRoom	Joins a room. Chat user has to be logged in before this operation.
Public method	KickUser	Kicks a chat user from a room. Currently logged user must be an admin to kick another user.
Public method	KickUserPermanently	Kickes user permanently from a private room. If this room is public, it acts as a normal kick. Kicked user won't be able to enter room again, unless he will be invited one more time.
Public method	LeaveRoom	Leaves chat room.
Public method	LeaveRoomPermanently	Permanently leaves current user from the private chat room (Join/Admin rights are removed from this room). If room is not private, it acts as normale LeaveRoom().
Public method	Logout	Logouts chat user from chat (not CMSUser). Leaves all rooms. If CMSUser is logged in, this operation won't logout the chat user in reality.
Public method	Ping	Keeps user online in global list of chat online users (this method needs to be called periodically). Checks if there were any changes in: - rooms (new room added, changed name, etc.) since lastRoomsChange. - counts of users in rooms since lastUsersInRoomsChange. - global online users since lastOnlineUsersChange. - notifications for online user since lastNotificationChange. If any of this objects has changed, changes are send back to client. If any of params is null, its objects are not checked. If param is 0, it is the first request and all objects are returned. If user is not online on chat, only CurrentChatUserState will be returned and data (rooms, online users, etc.) will be null.
Public method	PingInitiate	Checks if there is new initiated chat request pending for this user and returns it. Returns null if there is nothing. Requests are searched by ContactID and UserID.
Public method	PingRoom	Keeping alive user in a room. User has to call this method every few seconds to let server know that he is still online. At the same time a new online users in a room and a new messages in a room are checked. Client sends the last time he made an update of online users (roomUsersLastChange) and messages (roomMessagesLastChange). If something new has happened since that time, the changes are sent back.
Public method	PostMessage	Posts a new message to a room. Chat user has to be logged in and joined this room. Message can not be empty.
Public method	PostMessageToUser	Posts a whisper message to user. This message will be posted to a room, but only sender and receiver of this messages will be able to see it.
Public method	Register	Registers new anonymous chat user. This new user is automatically logged in.
Public method	RegisterGuest	Registers new guest user (user with auto generated nickname).
Public method	RejectMessage	Rejects the message. Checks for permissions for a specified room (roomID can be get from messageID) and if current chat user has admin rights, it rejects the message.
Public method	SearchOnlineUsers	Search users who are online globally on a chat (they are performing Ping()) and meet condition (their nickname contains nickname.
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.)