Class ChatWidgetSettings

Defines the look of the chat widget.

Carrier object for ChatWidgetSettings. Services for the ChatWidgetSettings Carrier is available from the IChatAgent.
Inheritance
Object
ChatWidgetSettings
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class ChatWidgetSettings : Object

Constructors

ChatWidgetSettings()

Default constructor

Declaration
public ChatWidgetSettings()
See Also

Properties

AgentMsgColor

Optional color for chat widget agent message

Declaration
public virtual string AgentMsgColor { get; set; }
Property Value
Type Description
String
See Also

AgentMsgTextColor

Optional color for chat widget agent message text

Declaration
public virtual string AgentMsgTextColor { get; set; }
Property Value
Type Description
String
See Also

AutoFaqCategory

Root folder for FAQ suggestions

Declaration
public virtual KbCategory AutoFaqCategory { get; set; }
Property Value
Type Description
KbCategory
See Also

AutoFaqEnabled

Enable automatic FAQ suggestions

Declaration
public virtual bool AutoFaqEnabled { get; set; }
Property Value
Type Description
Boolean
See Also

BadgeColor

Optional color for chat widget badge

Declaration
public virtual string BadgeColor { get; set; }
Property Value
Type Description
String
See Also

BadgeTextColor

Optional color for chat widget badge text

Declaration
public virtual string BadgeTextColor { get; set; }
Property Value
Type Description
String
See Also

ButtonColor

Optional color for chat widget button

Declaration
public virtual string ButtonColor { get; set; }
Property Value
Type Description
String
See Also

ButtonTextColor

Optional color for chat widget button text

Declaration
public virtual string ButtonTextColor { get; set; }
Property Value
Type Description
String
See Also

Color

The base color of the widget

Declaration
public virtual string Color { get; set; }
Property Value
Type Description
String
See Also

CustMsgColor

Optional color for chat widget customer message

Declaration
public virtual string CustMsgColor { get; set; }
Property Value
Type Description
String
See Also

CustMsgTextColor

Optional color for chat widget customer message text

Declaration
public virtual string CustMsgTextColor { get; set; }
Property Value
Type Description
String
See Also

Font

The font used in the widget

Declaration
public virtual string Font { get; set; }
Property Value
Type Description
String
See Also

FontSize

Optional size for chat widget font

Declaration
public virtual string FontSize { get; set; }
Property Value
Type Description
String
See Also

LanguageIsoCode

The language ISO code for the widget language

Declaration
public virtual string LanguageIsoCode { get; set; }
Property Value
Type Description
String
See Also

LogoBlobId

Blob id that contains logo image

Declaration
public virtual int LogoBlobId { get; set; }
Property Value
Type Description
Int32
See Also

LogoEnabled

Indicates if the logo should be shown in the widget

Declaration
public virtual bool LogoEnabled { get; set; }
Property Value
Type Description
Boolean
See Also

LogoName

filename/description of logo (from blob)

Declaration
public virtual string LogoName { get; set; }
Property Value
Type Description
String
See Also

OfflineFields

Required field when creating ticket in offline mode

Declaration
public virtual WidgetRequiredFields OfflineFields { get; set; }
Property Value
Type Description
WidgetRequiredFields
See Also

OfflineHeader

Offline text shown in widget header

Declaration
public virtual string OfflineHeader { get; set; }
Property Value
Type Description
String
See Also

OfflineMessage

Offline message shown in widget

Declaration
public virtual string OfflineMessage { get; set; }
Property Value
Type Description
String
See Also

PostFormEnabled

Enable post chat form

Declaration
public virtual bool PostFormEnabled { get; set; }
Property Value
Type Description
Boolean
See Also

PostFormHeader

Header text to show in post chat form

Declaration
public virtual string PostFormHeader { get; set; }
Property Value
Type Description
String
See Also

PostFormMessage

Message text to show in post chat form

Declaration
public virtual string PostFormMessage { get; set; }
Property Value
Type Description
String
See Also

PostTranscriptEnabled

Enable transcript of chat session

Declaration
public virtual bool PostTranscriptEnabled { get; set; }
Property Value
Type Description
Boolean
See Also

PreFormEnabled

Enable pre-chat form for anonymous users

Declaration
public virtual bool PreFormEnabled { get; set; }
Property Value
Type Description
Boolean
See Also

PreFormMessage

Message to be shown in a pre-chat

Declaration
public virtual string PreFormMessage { get; set; }
Property Value
Type Description
String
See Also

RequiredFields

Fields required to start a chat

Declaration
public virtual WidgetRequiredFields RequiredFields { get; set; }
Property Value
Type Description
WidgetRequiredFields
See Also

ShowAgentPhoto

Use agent photo and name when chatting

Declaration
public virtual bool ShowAgentPhoto { get; set; }
Property Value
Type Description
Boolean
See Also

Size

Chat widget size: normal or large.

Declaration
public virtual ChatWidgetSize Size { get; set; }
Property Value
Type Description
ChatWidgetSize
See Also

Theme

Predefined themes for the chat widget

Declaration
public virtual WidgetTheme Theme { get; set; }
Property Value
Type Description
WidgetTheme
See Also

UseAgentFirstname

Whether to use the firstname of the agent in the chat widget.

Declaration
public virtual bool UseAgentFirstname { get; set; }
Property Value
Type Description
Boolean
See Also

WelcomeMessage

Short message displayed as long as the request is in queue or active

Declaration
public virtual string WelcomeMessage { get; set; }
Property Value
Type Description
String
See Also

WelcomeTitle

Short welcome message when user initiates a chat

Declaration
public virtual string WelcomeTitle { get; set; }
Property Value
Type Description
String
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
See Also

See Also