ChannelPluginSettings
An object that contains information for ChannelIO settings
property | type | description |
---|---|---|
pluginKey | String | a plugin key that you can obtain from Channel Desk |
memberId | String | a member id |
debugMode | Boolean | a flag to indicate debug mode. Default is false |
hideDefaultInAppPush | Boolean | a flag to set visibility of the default in-app push. Default is false |
enabledTrackDefaultEvent | Boolean | a flag to enable tracking default events. Default is true |
language | String | a locale code, currently supports en, ko and ja. Default is device locale |
profile | Object | an 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
})
Updated about 1 year ago