BeaconDatastore

interface BeaconDatastore

Used to persist Beacon related config this is intended to be internal only

Functions

addSpecialAttributes

abstract fun addSpecialAttributes(company: String?, jobTitle: String?, avatar: String?)

clear

abstract fun clear()

clearContactFormDraft

abstract fun clearContactFormDraft(invokedByDeveloper: Boolean = false)

clearPrefilledForm

abstract fun clearPrefilledForm()

clearSessionAttributes

abstract fun clearSessionAttributes()

getBeaconUser

abstract fun getBeaconUser(): BeaconUser

getConfigWithOverrides

abstract fun getConfigWithOverrides(): BeaconConfigApi

How the config should always be retrieved

abstract fun login(email: String, name: String?)

Should only be called from Beacon.

logout

abstract fun logout()

setInitialValues

abstract fun setInitialValues()

userHasEmail

abstract fun userHasEmail(): Boolean

Has an email been saved.

Properties

agents

abstract var agents: List<BeaconAgent>

appId

abstract var appId: String

authType

abstract val authType: BeaconAuthType

avatar

abstract var avatar: String?

baseDocsUrl

abstract val baseDocsUrl: String?

beaconConfigOverrides

abstract var beaconConfigOverrides: BeaconConfigOverrides

beaconId

abstract var beaconId: String

chatConfig

abstract val chatConfig: ChatConfigApi

chatEnabled

abstract val chatEnabled: Boolean

company

abstract var company: String?

companyName

abstract val companyName: String?

contactFormDraft

abstract var contactFormDraft: PreFilledForm

contactFormOptions

abstract val contactFormOptions: ContactFormConfigApi

displayOptions

abstract val displayOptions: DisplayConfigApi

docsEnabled

abstract val docsEnabled: Boolean

abstract var email: String

enablePreviousMessages

abstract val enablePreviousMessages: Boolean

hasPreviousConversations

abstract var hasPreviousConversations: Boolean

Is there any previous conversations - Used UI to hide/show or Nav to different pages

installId

abstract var installId: String

isVisitor

abstract var isVisitor: Boolean

Boolean to check if the customer entered their own email (true) or (false) if the email was added by the developer via Beacon.

jobTitle

abstract var jobTitle: String?

logsEnabled

abstract var logsEnabled: Boolean

messagingEnabled

abstract val messagingEnabled: Boolean

name

abstract var name: String?

overrideChatEnabled

abstract var overrideChatEnabled: Boolean

overrideDocsEnabled

abstract var overrideDocsEnabled: Boolean

overrideMessagingEnabled

abstract var overrideMessagingEnabled: Boolean

preFilledForm

abstract var preFilledForm: PreFilledForm

pushToken

abstract var pushToken: String

pushTokenRegistered

abstract var pushTokenRegistered: Boolean

rawConfig

abstract var rawConfig: BeaconConfigApi

beacon config from api - Use getConfigWithOverrides() to ensure local overrides applied

sessionAttributes

abstract var sessionAttributes: Map<String, String>

shouldIdentifyCustomer

abstract var shouldIdentifyCustomer: Boolean

Indicates whether a call to IdentifyCustomer API is due

showPrefilledCustomFields

abstract var showPrefilledCustomFields: Boolean

signature

abstract var signature: String

suggestionArticles

abstract var suggestionArticles: List<SuggestedArticle>

userAttributes

abstract var userAttributes: MutableMap<String, String>