beacon/com.helpscout.beacon/Beacon

Beacon

class Beacon

Types

Builder

class Builder

A builder class used to configure and set up your Beacon instance.

Functions

addAttributeWithKey

open fun addAttributeWithKey(@NotNull key: @NotNull String, @NotNull value: @NotNull String): Boolean

Adds a user attribute represented as a key/value pair.

addPreFilledForm

open fun addPreFilledForm(preFilledForm: PreFilledForm)

Allows pre-filling of the contact form with specified data.

beaconId

open fun beaconId(): String

Returns the ID of this Beacon.

chatEnabled

open fun chatEnabled(): Boolean

Checks if the Realtime chat feature is enabled for this Beacon.

clear

open fun clear()

Performs a complete reset of the Beacon SDK, clearing all persisted data and state.

clearAttributes

open fun clearAttributes()

Removes all user attributes associated with the current user.

contactFormReset

open fun contactFormReset()

Resets the contact form by clearing all of its fields, custom fields, and attachments.

docsEnabled

open fun docsEnabled(): Boolean

Checks if the Docs feature is enabled for this Beacon.

open fun email(): String

Returns the email address used to identify the user.

getSessionAttributes

@NotNull

open fun getSessionAttributes(): @NotNull Map<String, String>

Retrieves the current session attributes.

identify

open fun identify(@NotNull email: @NotNull String)

Identifies a user for the Beacon, primarily when Beacon is configured for normal mode.

open fun identify(@NotNull email: @NotNull String, @Nullable name: String)

Identifies a user with an email and name, primarily when Beacon is configured for normal mode.

open fun identify(@NotNull email: @NotNull String, @Nullable name: String, @Nullable company: String, @Nullable jobTitle: String, @Nullable avatar: String)

Used to identify users plus adds support for special attributes.

isEnabled

open fun isEnabled(): Boolean

Checks if Beacon is currently enabled.

logout

open fun logout()

open fun logout(endActiveChat: Boolean)

Clears the current user's session and identity data.

logsEnabled

open fun logsEnabled(): Boolean

Enables application logging to Logcat for debugging purposes only.

messagingEnabled

open fun messagingEnabled(): Boolean

Checks if the Messaging/contact form feature is enabled for this Beacon.

previousMessagesEnabled

open fun previousMessagesEnabled(): Boolean

Checks if previous messages are enabled for this Beacon.

removeAttribute

open fun removeAttribute(@NotNull key: @NotNull String): Boolean

Removes a specific user attribute.

resetSuggestedArticlesOverrides

open fun resetSuggestedArticlesOverrides()

Clears any previously set overrides for suggested articles or links.

setConfigOverrides

open fun setConfigOverrides(@NotNull configOverrides: @NotNull BeaconConfigOverrides)

Overrides the configuration from the Beacon Builder, which is defined on the Help Scout Beacon admin page.

setFirebaseCloudMessagingToken

open fun setFirebaseCloudMessagingToken(@NotNull context: @NotNull Context, token: String)

Stores the Firebase Cloud Messaging token for push notifications.

setOverrideChatEnabled

open fun setOverrideChatEnabled(overrideChatEnabled: Boolean)

Overrides and disables the Beacon Builder real-time chat option.

setOverrideDocsEnabled

open fun setOverrideDocsEnabled(overrideDocsEnabled: Boolean)

Overrides and disables the Beacon Builder Articles/Docs option.

setOverrideMessagingEnabled

open fun setOverrideMessagingEnabled(messagingEnabled: Boolean)

Overrides and disables the Beacon Builder Messaging/Contact form option.

setOverrideSuggestedArticles

open fun ~~setOverrideSuggestedArticles~~(articleIds: List<String>)

Overrides the suggested articles displayed on the Help & Support screen.

setOverrideSuggestedArticlesOrLinks

open fun setOverrideSuggestedArticlesOrLinks(suggestions: List<SuggestedArticle>)

Overrides the suggested articles or links displayed on the Help & Support screen.

setSessionAttributes

open fun setSessionAttributes(@NotNull sessionAttributes: @NotNull Map<String, String>): Boolean

Adds session attributes to the next chat or conversation sent via the Beacon SDK.

showPrefilledCustomFields

open fun showPrefilledCustomFields(show: Boolean)

Controls whether users of the contact form can see and edit custom field values when they are pre-filled.

userHasEmail

open fun userHasEmail(): Boolean

Checks if an email address has been defined for the current user.

version

open fun version(): String

Returns the current version of the Beacon SDK.