This document explains the boot options as parameters for boot.
For usage examples, refer to Quick Start.
type | description |
|---|---|
| Your channel's plugin key. |
type | description |
|---|---|
| The ID of the member user. |
type | description |
|---|---|
| The CSS Selector to select a custom launcher. Use this option to customize the default chat button. |
type | description |
|---|---|
| Determines whether to hide the default chat button on boot. The default value is |
type | description |
|---|---|
| Sets the z-index for SDK elements, such as the chat button, messenger, and marketing pop-ups. The default value is |
type | description |
|---|---|
( | Sets the default language. This affects text display and sets the |
type | description |
|---|---|
| Determines whether to track the default event(PageView). The default value is |
type | description |
|---|---|
| Determines whether to track the UTM source and referrer. The default value is true. |
type | description |
|---|---|
| Sets the user’s profile. |
unsubscribe will be deprecated after 2023.
Use unsubscribeEmail and unsubscribeTexting instead.
type | description |
|---|---|
| Set whether to unsubscribe marketing emails and SMS for the user. The default value is |
type | description |
|---|---|
| Set whether to unsubscribe marketing emails for the user. The default value is |
type | description |
|---|---|
| Set whether to unsubscribe marketing SMS for the user. The default value is |
type | description |
|---|---|
|
type | description |
|---|---|
| Determines whether to hide marketing and message alarm pop-ups. The default value is |
type | description |
|---|---|
( | Set the initial theme appearance. The default value is |
'light': Use the light theme.'dark"': Use the dark theme.'system': Follow the system theme.null: Follow the desk’s theme setting.