RoomState Class

Class holding caches of messages and online users in one room.

Inheritance Hierarchy

System.Object
  CMS.Chat.RoomState

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

Syntax

public class RoomState

The RoomState type exposes the following members.

Constructors

	Name	Description
Public method	RoomState	Constructor. parentName is used to create cache keys.

Methods

	Name	Description
Public method	ForceIsUserOnline	Checks if user is online. Caller of this method expects that user is online. If user is not online in cache, this method checks database.
Public method	ForceTryGetUser	Gets online user. Caller expects that user is present in list of online users.
Public method	GetMessages	Gets newest messages.
Public method	GetOnlineUsers	Gets online users in this room. Changed or all (sinceWhen is null).
Public method	InvalidateKickedUsers	Invalidate list of kicked users in this room.
Public method	IsUserKicked(Int32)	Checks if the chat users specified by chatUserID is kicked from this room.
Public method	IsUserKicked(Int32, Int32)	Checks if the chat users specified by chatUserID is kicked from this room.
Public method	ReloadChatRoomInfo	Reloads info about this chat room. Should be called every time after room is changed.
Public method	TryGetUser	Gets online user.

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
Public property	OnlineUsers	List of online users in this room. Contains not only online users, but also users with Admin rights, Join rights (private rooms), etc.
Public property	RoomInfo	Gets ChatRoomInfo of this room. Properties of this room can't be change via this instance (use ReloadChatRoomInfo() instead).