com.helpscout.beacon.model

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

BeaconScreens

enum BeaconScreens : Enum<BeaconScreens>

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

BeaconUser

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

FocusMode

enum FocusMode : Enum<FocusMode>

Messaging mode

PreFilledForm

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

Pre filled details for the Messaging Contact form.

SerializableSuggestedArticle

data class SerializableSuggestedArticle(@Json(name = id) id: String?, @Json(name = url) url: String?, @Json(name = title) title: String?)

Internal class used only for serialising SuggestedArticle overrides.

SuggestedArticle

interface SuggestedArticle

SuggestedArticle used to override the suggested articles/Instant answers from the Beacon APISuggestedArticle used to be a Kotlin Sealed class however it caused issues for Java consumers due to lack of surrounding class.

colorOnlyBeaconConfigOverrides

fun colorOnlyBeaconConfigOverrides(overrideColor: String): BeaconConfigOverrides

Helper function is you just want to override the Beacon color

emptyBeaconConfigOverrides

fun emptyBeaconConfigOverrides(): BeaconConfigOverrides

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

EMPTY_PREFILLED_FORM

val EMPTY_PREFILLED_FORM: PreFilledForm

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

Package com.helpscout.beacon.model

Types

Functions

Properties