beacon/com.helpscout.beacon.model/BeaconConfigOverrides/BeaconConfigOverrides

BeaconConfigOverrides

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

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.

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

Deprecated

Use the primary constructor with ContactFormConfig instead of ContactFormConfigApi

Replace with

import com.helpscout.beacon.model.ContactFormConfig

BeaconConfigOverrides(docsEnabled, messagingEnabled, chatEnabled, contactForm?.let { ContactFormConfig(it.showName, it.showSubject, it.allowAttachments, it.customFieldsEnabled) }, color, focusMode, enablePreviousMessages)

Legacy constructor for backwards compatibility.