BeaconConfigOverrides

@Serializable
data class BeaconConfigOverrides @JvmOverloads constructor(val docsEnabled: Boolean? = null, val messagingEnabled: Boolean? = null, val chatEnabled: Boolean? = null, val contactForm: ContactFormConfig? = null, val color: String? = null, val focusMode: FocusMode? = null, val enablePreviousMessages: Boolean = true)

BeaconConfigOverrides allows you to override certain data provided by the Beacon Builder on Help Scout

Parameters

docsEnabled

whether to show suggestions screen and allow Articles to be searched and viewed

messagingEnabled

allow users to contact via Beacon messaging contact form

chatEnabled

allow users contact using real time chat

contactForm

allows overriding whether to hide specific fields in the Beacon messaging contact form

color

override the Beacon color. Format #RRGGBB i.e #FF0000 for a red.

focusMode

controls prominence of contact options to visitors.

enablePreviousMessages

enable or disable Previous Messages in Beacon. Defaults to true.

Constructors

Link copied to clipboard
constructor(docsEnabled: Boolean? = null, messagingEnabled: Boolean? = null, chatEnabled: Boolean? = null, contactForm: ContactFormConfig? = null, color: String? = null, focusMode: FocusMode? = null, enablePreviousMessages: Boolean = true)
constructor(docsEnabled: Boolean? = null, messagingEnabled: Boolean? = null, chatEnabled: Boolean? = null, contactForm: ContactFormConfigApi? = null, color: String? = null, focusMode: FocusMode? = null, enablePreviousMessages: Boolean = true)

Legacy constructor for backwards compatibility.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard