Skip to main content

Class ChatWidgetSettings

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for ChatWidgetSettings. Defines the look of the chat widget.

Inheritance

objectChatWidgetSettings

Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

ChatWidgetSettings()

Default constructor - defaults any enum props to 0.

Properties

AgentMsgColor

Optional color for chat widget agent message

Property Value

string

AgentMsgTextColor

Optional color for chat widget agent message text

Property Value

string

AutoFaqCategory

Root folder for FAQ suggestions

Property Value

KbCategory

AutoFaqEnabled

Enable automatic FAQ suggestions

Property Value

bool

BadgeColor

Optional color for chat widget badge

Property Value

string

BadgeTextColor

Optional color for chat widget badge text

Property Value

string

ButtonColor

Optional color for chat widget button

Property Value

string

ButtonTextColor

Optional color for chat widget button text

Property Value

string

Color

The base color of the widget

Property Value

string

CustMsgColor

Optional color for chat widget customer message

Property Value

string

CustMsgTextColor

Optional color for chat widget customer message text

Property Value

string

Font

The font used in the widget

Property Value

string

FontSize

Optional size for chat widget font

Property Value

string

LanguageIsoCode

The language ISO code for the widget language

Property Value

string

LogoBlobId

Blob id that contains logo image

Property Value

int

LogoEnabled

Indicates if the logo should be shown in the widget

Property Value

bool

LogoName

filename/description of logo (from blob)

Property Value

string

OfflineFields

Required field when creating ticket in offline mode NULL if unknown enum value.

Property Value

WidgetRequiredFields?

See Also

ChatWidgetSettings.OfflineFields_String

OfflineFields_String

Required field when creating ticket in offline mode Raw string enum value.

Property Value

string

See Also

ChatWidgetSettings.OfflineFields

OfflineHeader

Offline text shown in widget header

Property Value

string

OfflineMessage

Offline message shown in widget

Property Value

string

PostFormEnabled

Enable post chat form

Property Value

bool

PostFormHeader

Header text to show in post chat form

Property Value

string

PostFormMessage

Message text to show in post chat form

Property Value

string

PostTranscriptEnabled

Enable transcript of chat session

Property Value

bool

PreFormEnabled

Enable pre-chat form for anonymous users

Property Value

bool

PreFormMessage

Message to be shown in a pre-chat

Property Value

string

RequiredFields

Fields required to start a chat NULL if unknown enum value.

Property Value

WidgetRequiredFields?

See Also

ChatWidgetSettings.RequiredFields_String

RequiredFields_String

Fields required to start a chat Raw string enum value.

Property Value

string

See Also

ChatWidgetSettings.RequiredFields

ShowAgentPhoto

Use agent photo and name when chatting

Property Value

bool

Size

Chat widget size: normal or large. NULL if unknown enum value.

Property Value

ChatWidgetSize?

See Also

ChatWidgetSettings.Size_String

Size_String

Chat widget size: normal or large. Raw string enum value.

Property Value

string

See Also

ChatWidgetSettings.Size

Theme

Predefined themes for the chat widget NULL if unknown enum value.

Property Value

WidgetTheme?

See Also

ChatWidgetSettings.Theme_String

Theme_String

Predefined themes for the chat widget Raw string enum value.

Property Value

string

See Also

ChatWidgetSettings.Theme

UseAgentFirstname

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

Property Value

bool

WelcomeMessage

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

Property Value

string

WelcomeTitle

Short welcome message when user initiates a chat

Property Value

string

See Also

ChatAgent