Category
API Reference
API Reference
Boot Option
This document explains the boot options as parameters for boot. For usage examples, refer to Quick Start. Required options pluginKey type description string Your channel's plugin key. Optional options memberId type description string The ID of the member user. customLauncherSelector type description string The CSS Selector to select a custom launcher. Use this option to customize the default chat button. hideChannelButtonOnBoot type description boolean Determines whether to hide the default chat
ChannelIO
boot Initialize for the SDK. The Channel button appears, and features like the marketing pop-up are ready to use. For more details, see boot. ChannelIO('boot', bootOption: object, callback?: Function) parameter type description bootOption object A boot option to initialize the SDK. callback (optional) Function Callback function executed after boot. If boot fails, the callback receives an error object as the first argument and null as the second argument. If boot succeeds, the callback receives n
User Object
This document explains the user object. Refer to the user object example for more details. id type description string The user's ID. memberId To create a member user, you must use memberId. Refer to the memberId in the boot option and the boot. type description string The ID used for recognizing a member user. If memberId is specified in the boot option, the user is considered a member user. name type description string | undefined The name of a user. Set via updateUser. avatarUrl type descripti
Legacy
This document explains the SDK that are no longer supported or are about to be deprecated. We recommend not using the legacy SDKs described in this document. Legacy SDKs can be removed at any time, which can lead to errors. If you are already using the SDK, replace it as soon as possible through the SDK’s migration guide. ChannelIO show Show the messenger. ChannelIO('show'); Migration guide Use showMessenger instead. hide Hide the messenger. ChannelIO('hide'); Migration guide Use hideMessenger i