BeaconConfigOverrides

data class BeaconConfigOverrides @JvmOverloads() constructor(docsEnabled: Boolean?, messagingEnabled: Boolean?, chatEnabled: Boolean?, contactForm: ContactFormConfigApi?, color: String?, focusMode: FocusMode?, enablePreviousMessages: Boolean)

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

BeaconConfigOverrides
Link copied to clipboard
fun BeaconConfigOverrides(docsEnabled: Boolean? = null, messagingEnabled: Boolean? = null, chatEnabled: Boolean? = null, contactForm: ContactFormConfigApi? = null, color: String? = null, focusMode: FocusMode? = null, enablePreviousMessages: Boolean = true)
whether to show suggestions screen and allow Articles to be searched and viewed

Properties

chatEnabled
Link copied to clipboard
val chatEnabled: Boolean? = null
allow users contact using real time chat
color
Link copied to clipboard
val color: String? = null
override the Beacon color.
contactForm
Link copied to clipboard
val contactForm: ContactFormConfigApi? = null
allows overriding whether to hide specific fields in the Beacon messaging contact form
docsEnabled
Link copied to clipboard
val docsEnabled: Boolean? = null
whether to show suggestions screen and allow Articles to be searched and viewed
enablePreviousMessages
Link copied to clipboard
val enablePreviousMessages: Boolean = true
enable or disable Previous Messages in Beacon.
focusMode
Link copied to clipboard
val focusMode: FocusMode? = null
controls prominence of contact options to visitors.
messagingEnabled
Link copied to clipboard
val messagingEnabled: Boolean? = null
allow users to contact via Beacon messaging contact form