ChatUIHelper Class

Provides helper methods for chat UI.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<ChatUIHelper>
        CMS.Chat.Web.UI.ChatUIHelper

Namespace: CMS.Chat.Web.UI
Assembly: CMS.Chat.Web.UI (in CMS.Chat.Web.UI.dll) Version: 10.0.0

Syntax

public class ChatUIHelper : AbstractHelper<ChatUIHelper>

The ChatUIHelper type exposes the following members.

Constructors

	Name	Description
Public method	ChatUIHelper

Methods

	Name	Description
Public method Static member	GetCMSDeskChatUserField(Control, ChatUserInfo)	Gets string representation which can be used to display chat user in CMS Desk. If user is not anonymous, returned string is a HTML code which contains anchor to open user's details in new window. If user is anonymous, returned string will be simply his nickname. Nickname will be always HTML encoded.
Public method Static member	GetCMSDeskChatUserField(Control, Int32, String, Boolean)	Gets string representation which can be used to display chat user in CMS Desk. If user is not anonymous, returned string is a HTML code which contains anchor to open user's details in new window. If user is anonymous, returned string will be simply his nickname. Nickname will be always HTML encoded.
Protected method	GetCMSDeskChatUserFieldInternal	Gets string representation which can be used to display chat user in CMS Desk. If user is not anonymous, returned string is a HTML code which contains anchor to open user's details in new window. If user is anonymous, returned string will be simply his nickname. Nickname will be always HTML encoded.
Public method Static member	GetChatRoomWindowURL	Returns chat room window url from global chat settings
Protected method	GetChatRoomWindowURLInternal	Returns chat room window url from global chat settings
Public method Static member	GetRoomIdFromQuery	Gets room ID from query or returns original room ID.
Protected method	GetRoomIdFromQueryInternal	Gets room ID from query or returns original room ID.
Public method Static member	GetWebpartLoadingDiv	Get webpart's loading div which is showed when data are loaded.
Protected method	GetWebpartLoadingDivInternal	Get webpart's loading div which is showed when data are loaded.
Public method Static member	GetWebpartTransformation	Gets webpart's transformation.
Protected method	GetWebpartTransformationInternal	Gets webpart's transformation.
Public method Static member	MakeWebpartEnvelope	Make webpart's envelope, which is used for styling and hiding.
Protected method	MakeWebpartEnvelopeInternal	Make webpart's envelope, which is used for styling and hiding.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)