Interface BootOption

Boot options for initializing the SDK.

See

https://developers.channel.io/docs/web-boot-option

Hierarchy

  • BootOption

Properties

appearance? customLauncherSelector? hideChannelButtonOnBoot? hidePopup? language? memberHash? memberId? pluginKey profile? trackDefaultEvent? trackUtmSource? unsubscribe? unsubscribeEmail? unsubscribeTexting? zIndex?

Properties

Optional appearance

appearance?: Appearance

Configure the initial appearance of your theme.

  • The default value is null.

Optional customLauncherSelector

customLauncherSelector?: string

Specifies a CSS selector to target the custom launcher.

  • Useful for customizing the default channel button.

See

Optional hideChannelButtonOnBoot

hideChannelButtonOnBoot?: boolean

Determines whether to hide the default channel button.

  • The default value is false.

See

Optional hidePopup

hidePopup?: boolean

Determines whether to hide marketing pop-ups and message alert pop-ups.

  • The default value is false.

Optional language

language?: string

Specifies the default language setting.

  • Applies to new users; does not modify existing users' language settings.
  • Supports message translation in 32 languages and UI language in ko, ja, and en.
  • UI text adapts to ko or ja; defaults to en otherwise.

See

Optional memberHash

memberHash?: string

Pass the HMAC-SHA256 hash of the user memberid using the issued secret key.

  • No need to pass memberHash unless using user data encryption.

See

Optional memberId

memberId?: string

Specifies the member user's ID.

See

https://developers.channel.io/docs/web-boot-option#memberid

pluginKey

pluginKey: string

Specifies the plugin key for your channel.

See

Optional profile

profile?: Profile

Specifies the user’s profile.

See

Optional trackDefaultEvent

trackDefaultEvent?: boolean

Determines whether to track the default PageView event.

  • The default value is true.

See

Optional trackUtmSource

trackUtmSource?: boolean

Determines whether to track the UTM source and referrer.

  • The default value is true.

See

https://developers.channel.io/docs/web-boot-option#trackutmsource

Optional unsubscribe

unsubscribe?: boolean

Determines whether to opt out of receiving marketing emails and text messages.

  • The default value is false.

Optional unsubscribeEmail

unsubscribeEmail?: boolean

Determines whether to opt out of receiving marketing emails.

  • The default value is false.

Optional unsubscribeTexting

unsubscribeTexting?: boolean

Determines whether to opt out of receiving marketing text messages.

  • The default value is false.

Optional zIndex

zIndex?: number

Sets the z-index for elements generated by the SDK.

  • Applies to the channel button, messenger, and marketing pop-ups.
  • The default value is 10,000,000.

See

https://developers.channel.io/docs/web-boot-option#zindex

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc