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 instead.
lounge
Move to the lounge.
ChannelIO('lounge');
onBoot
Register the callback function to execute when the boot is completed.
When the boot succeeds, the callback function passes a user object. When the boot fails, the callback function passes undefined
.
ChannelIO('onBoot', function(user) {
// YOUR CODE...
});
Migration guide
Use the callback parameter of the boot instead.
onShow
Register a callback function to execute when the messenger is opened.
ChannelIO('onShow', function() {
// YOUR CODE...
});
Migration guide
Use onShowMessenger instead.
onHide
Register a callback function to execute when the messenger is hidden.
ChannelIO('onHide', function() {
// YOUR CODE...
});
Migration guide
Use the onHideMessenger instead.
onChangeBadge
Register a callback function to execute when the count of messages that the user has not yet read.
ChannelIO('onChangeBadge', function(unreadCount) {
// YOUR CODE...
});
Migration guide
Use the onBadgeChanged instead.
onCreateChat
Register a callback function to execute when a chat is created.
ChannelIO('onCreateChat', function() {
// YOUR CODE...
});
Migration guide
Use onChatCreated instead.
onProfileChanged
Register a callback function to execute when the user changes the user’s profile.
The profile object passed to the argument of the callback function includes the following fields.
name
: user’s nameemail
: user’s emailmobileNumber
: user’s mobile number
ChannelIO('onProfileChanged', function(profile) {
// YOUR CODE...
});
Migration guide
Use onFollowUpChanged instead.
onChangeProfile
Register a callback function to execute when the user changes the user’s profile.
The profile object passed to the argument of the callback function includes the following fields.
name
: user’s nameemail
: user’s emailmobileNumber
: user’s mobile number
ChannelIO('onChangeProfile', function(profile) {
// YOUR CODE...
});
Migration guide
Use onFollowUpChanged instead.
onClickRedirect
Register a callback function to execute when the user clicks a link.
The links that the user can click include the following list.
- Link button/text in marketing pop-up
- Link button/text sent by manager in chat
ChannelIO('onUrlClicked', function(url) {
// YOUR CODE...
});
Migration guide
Use onUrlClicked instead.
Boot Option
hideDefaultLauncher
Set whether to hide a default channel button.
Migration guide
Use hideChannelButtonOnBoot를 instead.
locale
Set a default language.
Migration guide
Use language instead.
enabledTrackDefaultEvent
Set whether to track a default event(PageView).
Migration guide
Use trackDefaultEvent instead.
enabledUtmSourceTrack
Set whether to track the UTM source and referrer or not.
Migration guide
Use trackUtmSource instead.
mobileOpenUI
Set the way a chat is opened.
Migration guide
Set mobileMessengerMode instead.
Updated 5 months ago