Class ChatWidgetSettings

Defines the look of the chat widget.

Carrier object for ChatWidgetSettings. Services for the ChatWidgetSettings Carrier is available from the Chat Agent.

Inheritance

object

ChatWidgetSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.2.0.0")]
public class ChatWidgetSettings

Constructors

ChatWidgetSettings()

Default constructor

Declaration

public ChatWidgetSettings()

See Also

IChatAgent

Properties

AgentMsgColor

Optional color for chat widget agent message

Declaration

[DataMember]
public virtual string AgentMsgColor { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

AgentMsgTextColor

Optional color for chat widget agent message text

Declaration

[DataMember]
public virtual string AgentMsgTextColor { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

AutoFaqCategory

Root folder for FAQ suggestions

Declaration

[DataMember]
public virtual KbCategory AutoFaqCategory { get; set; }

Property Value

Type	Description
KbCategory

See Also

IChatAgent

AutoFaqEnabled

Enable automatic FAQ suggestions

Declaration

[DataMember]
public virtual bool AutoFaqEnabled { get; set; }

Property Value

Type	Description
bool

See Also

IChatAgent

BadgeColor

Optional color for chat widget badge

Declaration

[DataMember]
public virtual string BadgeColor { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

BadgeTextColor

Optional color for chat widget badge text

Declaration

[DataMember]
public virtual string BadgeTextColor { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

ButtonColor

Optional color for chat widget button

Declaration

[DataMember]
public virtual string ButtonColor { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

ButtonTextColor

Optional color for chat widget button text

Declaration

[DataMember]
public virtual string ButtonTextColor { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

Color

The base color of the widget

Declaration

[DataMember]
public virtual string Color { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

CustMsgColor

Optional color for chat widget customer message

Declaration

[DataMember]
public virtual string CustMsgColor { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

CustMsgTextColor

Optional color for chat widget customer message text

Declaration

[DataMember]
public virtual string CustMsgTextColor { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

Font

The font used in the widget

Declaration

[DataMember]
public virtual string Font { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

FontSize

Optional size for chat widget font

Declaration

[DataMember]
public virtual string FontSize { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

LanguageIsoCode

The language ISO code for the widget language

Declaration

[DataMember]
public virtual string LanguageIsoCode { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

LogoBlobId

Blob id that contains logo image

Declaration

[DataMember]
public virtual int LogoBlobId { get; set; }

Property Value

Type	Description
int

See Also

IChatAgent

LogoEnabled

Indicates if the logo should be shown in the widget

Declaration

[DataMember]
public virtual bool LogoEnabled { get; set; }

Property Value

Type	Description
bool

See Also

IChatAgent

LogoName

filename/description of logo (from blob)

Declaration

[DataMember]
public virtual string LogoName { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

OfflineFields

Required field when creating ticket in offline mode

Declaration

[DataMember]
public virtual WidgetRequiredFields OfflineFields { get; set; }

Property Value

Type	Description
WidgetRequiredFields

See Also

IChatAgent

OfflineHeader

Offline text shown in widget header

Declaration

[DataMember]
public virtual string OfflineHeader { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

OfflineMessage

Offline message shown in widget

Declaration

[DataMember]
public virtual string OfflineMessage { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

PostFormEnabled

Enable post chat form

Declaration

[DataMember]
public virtual bool PostFormEnabled { get; set; }

Property Value

Type	Description
bool

See Also

IChatAgent

PostFormHeader

Header text to show in post chat form

Declaration

[DataMember]
public virtual string PostFormHeader { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

PostFormMessage

Message text to show in post chat form

Declaration

[DataMember]
public virtual string PostFormMessage { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

PostTranscriptEnabled

Enable transcript of chat session

Declaration

[DataMember]
public virtual bool PostTranscriptEnabled { get; set; }

Property Value

Type	Description
bool

See Also

IChatAgent

PreFormEnabled

Enable pre-chat form for anonymous users

Declaration

[DataMember]
public virtual bool PreFormEnabled { get; set; }

Property Value

Type	Description
bool

See Also

IChatAgent

PreFormMessage

Message to be shown in a pre-chat

Declaration

[DataMember]
public virtual string PreFormMessage { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

RequiredFields

Fields required to start a chat

Declaration

[DataMember]
public virtual WidgetRequiredFields RequiredFields { get; set; }

Property Value

Type	Description
WidgetRequiredFields

See Also

IChatAgent

ShowAgentPhoto

Use agent photo and name when chatting

Declaration

[DataMember]
public virtual bool ShowAgentPhoto { get; set; }

Property Value

Type	Description
bool

See Also

IChatAgent

Size

Chat widget size: normal or large.

Declaration

[DataMember]
public virtual ChatWidgetSize Size { get; set; }

Property Value

Type	Description
ChatWidgetSize

See Also

IChatAgent

Theme

Predefined themes for the chat widget

Declaration

[DataMember]
public virtual WidgetTheme Theme { get; set; }

Property Value

Type	Description
WidgetTheme

See Also

IChatAgent

UseAgentFirstname

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

Declaration

[DataMember]
public virtual bool UseAgentFirstname { get; set; }

Property Value

Type	Description
bool

See Also

IChatAgent

WelcomeMessage

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

Declaration

[DataMember]
public virtual string WelcomeMessage { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

WelcomeTitle

Short welcome message when user initiates a chat

Declaration

[DataMember]
public virtual string WelcomeTitle { get; set; }

Property Value

Type	Description
string

See Also

IChatAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration

public override string ToString()

Returns

Type	Description
string	The carrier contents.

Overrides

object.ToString()

See Also

IChatAgent

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

IChatAgent

See Also

IChatAgent