ChannelPluginSettings

An object that contains information for ChannelIO settings

propertytypedescription
pluginKeyStringa plugin key that you can obtain from Channel Desk
memberIdStringa member id
debugModeBooleana flag to indicate debug mode. Default is false
hideDefaultInAppPushBooleana flag to set visibility of the default in-app push. Default is false
enabledTrackDefaultEventBooleana flag to enable tracking default events. Default is true
languageStringa locale code, currently supports en, ko and ja. Default is device locale
profileObjectan object contains user information

❗️

Do not recommend to use a predictable value for memberId

Because memberId is a unique value that we use to identify users, we do not recommend to use predictable values such as numerical combination, email address, user name and etc. It may cause privacy and security issues. We recommend to use higher than 256 bits hash value.

var settings = {
    "pluginKey": "YOUR_PLUGIN_KEY",
    "memberId": "YOUR_USER_ID",
    "hideDefaultInAppPush": false,
    "language": "en",
    "profile": {
      "name": "YOUR_USER_NAME",
      "mobileNumber": "YOUR_USER_MOBILE_NUMBER",
      "email": "[email protected]",
      "avatarUrl": "http://IMAGE_URL",
      "CUSTOM_VALUE_1": "VALUE_1",
      "CUSTOM_VALUE_2": "VALUE_2"
    }
};

ChannelIO.boot(settings).then((result) => {
  //boot completed
})