Category
API Reference
API Reference
ChannelIO
initialize The initialize function is responsible for initializing ChannelIO and should be invoked prior to any other methods of ChannelIO. Parameter Type Default Value Description application @NonNullApplication Required An Application instance. attachView boolean true When set totrue, the SDK will automatically attach a view to display the channel button and marketing pop-ups within your activity.To exclude specific activities from this view attachment, use@SkipAttachChannelView. If set tofalsChannelPluginListener
The Channel Talk Android SDK offers a seamless chat UI along with useful information. In case you need further customization, you may need to use ChannelPluginListener. ChannelIO.setListener(object : ChannelPluginListener { // ... }) onShowMessenger Called when the messenger is shown. For example, a user clicks a channel button or ChannelIO.showMessenger() is called. onHideMessenger Called when the messenger is hidden. For example, a user clicks close button or ChannelIO.hideMessenger() is calleCallbacks
BootCallback A callback interface that ChannelIO.boot() notifies its result to. onComplete Parameter Type Description bootStatus @NonNull BootStatus A result of boot(). user @Nullable User An instance of current user. null if boot has failed. UserUpdateCallback A callback interface that is notified when the user information is updated. Usage is the following: - ChannelIO.updateUser() - ChannelIO.addTags() - ChannelIO.removeTags() onComplete Parameter Type Description e @Nullable Exception An excModels
BootConfig Configures options for ChannelIO.boot(). Field Type Description pluginKey @NonNull String A plugin key. memberId @Nullable String An identifier to distinguish each user. See how to boot as a member user. memberHash @Nullable String A HMAC-SHA256 value of memberId. See enabling member hash. You should also pass memberId whenever memberHash is non-null. profile @Nullable Profile A user’s profile. language @Nullable Language A user’s language. If null, the language is set to the language