Boot Option
This document explains boot options as the parameter of the boot.
See the example in Quick Start.
Required options
pluginKey
type | description |
---|---|
string | The plugin key of your channel. |
Optional options
memberId
type | description |
---|---|
string | The id of member user. |
customLauncherSelector
type | description |
---|---|
string | The CSS Selector to select custom launcher. Use when you customize default chat button. |
hideChannelButtonOnBoot
type | description |
---|---|
boolean | Set whether to hide the default chat button. The default value is false . |
zIndex
language
type | description |
---|---|
string ( ‘en’ | ‘ko’ | ’ja’ ) | Set the default value of the language. Texts differ based on the language . When a user is created newly, the user’s language is set as the language . language doesn’t change the user’s language already created. |
trackDefaultEvent
type | description |
---|---|
boolean | Set whether to track the default event(PageView) or not. The default value is true . |
trackUtmSource
type | description |
---|---|
boolean | Set whether to track the UTM source and referrer or not. The default value is true. |
profile
type | description |
---|---|
object | Set the user’s profile. |
mobileMessengerMode
We recommend using the default value,
"newTab"
option.The
"newTab"
option provides an optimized UI for a smooth chat experience.
type | description |
---|---|
string ( "newTab" | "iframe" ) | Set the way a chat is opened. When "newTab" , a chat is opened in a new tab. When "iframe" , a chat is opened in the iframe in the same tab.The default value is "newTab" . |
unsubscribe
unsubscribe
will be deprecated after 2023.Use the unsubscribeEmail and unsubscribeTexting instead.
type | description |
---|---|
boolean | Set whether to unsubscribe marketing email and SMS for the user. The default value is false . |
unsubscribeEmail
type | description |
---|---|
boolean | Set whether to unsubscribe marketing email for the user. The default value is false . |
unsubscribeTexting
type | description |
---|---|
boolean | Set whether to unsubscribe marketing SMS for the user. The default value is false . |
memberHash
hidePopup
type | description |
---|---|
boolean | Set whether to hide the marketing pop-ups and the message alarm pop-ups. The default value is false . |
appearance
type | description |
---|---|
string ( "light" | "dark" | "system" | null ) | Set the initial appearance of the theme. The default value is null . |
"light"
: Use the light theme."dark"
: Use the dark theme."system"
: Follow the system theme.null
: Follow the desk’s theme setting.
Updated about 1 month ago