beacon/com.helpscout.beacon.model

Package-level declarations

Types

@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

BeaconScreens allows developers to choose which screen to open when the Beacon is launched

data class BeaconUser(val email: String, val name: String? = null, val company: String? = null, val jobTitle: String? = null, val avatar: String? = null, val attributes: Map<String, String>)

Represents a Beacon user with identity and special attributes.

@Serializable

data class ContactFormConfig @JvmOverloads constructor(val showName: Boolean = true, val showSubject: Boolean = true, val allowAttachments: Boolean = true, val customFieldsEnabled: Boolean = true)

Configuration for the Beacon contact form that allows overriding field visibility.

@Serializable

Messaging mode

@Serializable

data class PreFilledForm @JvmOverloads constructor(val name: String = "", val subject: String = "", val message: String = "", val customFieldValues: Map<Int, String> = mutableMapOf(), val attachments: List<String> = emptyList(), val email: String = "")

Pre-filled details for the Messaging Contact form. Ideal for saving your users time typing.

SuggestedArticle used to override the suggested articles/Instant answers from the Beacon API

Helper to create a empty PreFilledForm useful for resetting your prefill options.

Helper function to create an empty overrides ideal if you want to reset any overrides you've set.