Interface Config

Contains the necessary parameters to instantiate a [[ChatBubble]] class

Hierarchy

  • Config

Properties

botId frontend? hostname? isPreview? locale? secure? timezone? userAgent userId? userInfo? userToken?

Properties

botId

botId: string

The identifier of the bot. The bot ID can be found in the URL when viewing the bot in the Botsquad studio.

Optional frontend

frontend?: string

The frontend parameter to pass to the websocket URL

Optional hostname

hostname?: string

The hostname of the endpoint. By default this points at bsdq.me. Leave unchanged in most cases.

Optional isPreview

isPreview?: boolean

Use the non-published version for the bot metadata

Optional locale

locale?: string

A valid ISO language code; for instance en, or nl_BE.

Optional secure

secure?: boolean

Whether the connecting endpoint uses HTTPS or not. Defaults to true. Leave unchanged in most cases.

Optional timezone

timezone?: string

The user's timezone, needs to be a valid timezone like Europe/Amsterdam.

userAgent

userAgent: string

The user agent string that identifies this client. The user agent needs to be structured like this: appname/version (OS os_version); for instance: `MyApp/1.0.0 (iOS 13.1.2)

Optional userId

userId?: string

An application-specific user identifier. Mutually exclusive with userToken; if userId is set, userToken will be ignored.

Optional userInfo

userInfo?: UserInfoConfig

An arbitrary context to pass in; will be used to pre-fill the bot CRM

Optional userToken

userToken?: string

The token that identifiers this user. The first time a connection is made, the token can be omitted, as it will be returned in the result of [[ChatBubble.connect]]. Each subsequent connect() call should have this same userToken parameter, to ensure that the user is correctly identified.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc