Migration

Migration to 12.0.0

• ChannelIO.openSupportBot(with:) is removed.
• You need to replace the usages of openSupportBot() with openWorkflow().

Migration from v10.0.0 to v11.0.0

onBadgeChanged(count:) is deprecated.

• onBadgeChanged(count:) is deprecated and renamed to onBadgeChanged(unread:alert:).
• The former method parameter count is moved to unread.
• Refer to onBadgeChanged(unread:alert:) for more details.

Migration from v9.0.0 to v10.0.0

Deprecated functions are removed. See migration-to-v8-from-v7 migration guide

BootConfig

• setUnsubscribed is removed. use setUnsubscribeEmail (email), setUnsubscribeTexting (sms, lms)

v9.1.2

let config = BootConfig()
config.unsubscribed = false

v10.0.0

let config = BootConfig()
config.unsubscribeEmail = false
config.unsubscribeTexting = false

Delegate

• onProfileChanged is removed.
• onFollowUpChanged is added.

// removed
func onProfileChanged(key: String, value: Any) {
  // ...
}

// added
func onFollowUpChanged(data: [String : Any]) {
  // ...
}

Migration to v9.1.2 from v9.0

Change import Schema from "ChannelIO" to "ChannelIOFront"

v9.0:

import ChannelIO

v9.1:

import ChannelIOFront

🚧

If you were not using memberId boot option,

The chat history can be initialized on only user-side after migrate to v9.1. This is the same situation as re-install of the app.
If you are using memberId, it works the same as before.

Migration to v8 from v7

Installation

❗️

New Install Guide

8.0.0 and later requires a new method of installation. Please check the new install guide.

ChannelIO functions

• boot use BootConfig except ChannelPluginSettings + Profile
• The completion of boot has been changed. Please check BootCallback
• show, hide is deprecated. Use showChannelButton, hideChannelButton
• open, close is deprecated. Use showMessenger, hideMessenger
• openChat with animate is deprecated. Use openChat
• canShowLauncher is deprecated.
• handlePushNotification is deprecated. Use storePushNotification / openStoredPushNotification / receivePushNotification
• updateUser with profile is depreacted. Use updateUser

BootConfig

• enabledTrackDefaultEvent is deprecated. Use trackDefaultEvent
• hideDefaultInAppPush is deprecated. Use hidePopup
• LauncherConfig is deprecated. Use ChannelButtonOption

Callback

• BootCompletion has changed. Please check BootCallback

Models

• PushEvent is deprecated. Use PopupData

Migration to v7 from v6

ChannelIO

boot

• The model of the completion callback in the boot function has changed

v6:

public class func boot(with: ChannelPluginSettings, profile: Profile?=nil, completion: ((ChannelPluginCompletionStatus, Guest?) -> Void)?=nil)

v7:

public class func boot(with: ChannelPluginSettings, profile: Profile?=nil, completion: ((ChannelPluginCompletionStatus, User?) -> Void)?=nil)

UpdateGuest

• Function renamed from UpdateGuest to UpdateUser
  -The model of the function completion callback has changed

v6:

public class func updateGuest(with profile: [String: Any?], completion: ((Bool, Guest?) -> Void)? = nil)

v7:

public class func updateUser(with profile: [String: Any?], completion: ((Bool, User?) -> Void)? = nil)

Guest

• The model has been renamed from Guest to User

ChannelPluginSettings

• The model properties have been renamed
• userId -> memberId
• locale -> language

ChannelPluginDelegate

onClickRedirect

• The delegate function has been deleted due to the suspension of the pushbot function.

Alamofire 5.0 migration

• we change Alamofire version 4.9 -> 5.0, so you need to [migration](reffer: https://github.com/Alamofire/Alamofire/blob/master/Documentation/Alamofire%205.0%20Migration%20Guide.md)
• ex) Alamofire -> AF ....