parameter | type | required | description |
|---|---|---|---|
application |
| O | An instance of the Application class. |
Initialize the ChannelIO object. You need to invoke this method at least once before utilizing any of the other ChannelIO methods.
This is required when using SceneDelegate. It returns ChannelWindow with UIWindowScene.
Declare a class variable for ChannelIO. In the example below, the variable is named channelWindow.
parameter | type | required | description |
|---|---|---|---|
windowScene |
| O | An instance of the UIWindowScene class. |
The delegation object for ChannelIO.
Load the information necessary to use the SDK. After successful Boot, you are ready to use the features of Channel Talk. For more details, refer to the Boot section.
parameter | type | required | description |
|---|---|---|---|
config | O | A configuration object for | |
completion |
| X | A callback from |
Disables all features except for receiving system push notifications and using the Track. Real-time functionalities (such as chat, marketing pop-ups, etc.) cannot be used due to the disconnected socket communication with Channel Talk servers. For more detailed guidance, refer to About life cycle.
Disconnects the SDK from the channel. The use of all features of the SDK is suspended. For more detailed guidance, refer to About life cycle.
Displays the Channel button on the global screen.
Hides the Channel button on the global screen.
Displays the messenger.
Hides the messenger.
Opens User chat. If the chatId exists, open it; otherwise, start a new chat.
parameter | type | required | description |
|---|---|---|---|
chatId |
| X | This is the chat ID.If the chatId is invalid or nil,a new user chat is opened. |
message |
| X | This is the pre-filled message in the message input field when opening a new chat.It is valid when chatId is nil. |
Deprecated. Use openWorkflow instead.
The support bot is no longer supported and was replaced by workflow. The behavior of openSupportBot is the same as that of openWorkflow. message parameter is ignored.
Opens User chat to run a specific Support bot.
parameter | type | required | description |
|---|---|---|---|
supportBotId |
| X | This is the support bot's ID.If supportBotId is invalid or nil,the chat room is closed. |
message |
| X | This message will be displayed in the input field after completing the support bot operation. |
Opens a user chat and starts the specified workflow.
openWorkflowcan only be executed when the workflow trigger is set to "When starting a chat via Channel Talk."If a corresponded workflow with the provided
workflowIdis exists, it will be executed. ifworkflowIdis invalid, an error page is displayed.If you don't pass
workflowId, no action is taken.
parameter | type | required | description |
|---|---|---|---|
workflowId |
| X | The ID of workflow to start with.An error page will be shown if such workflow does not exist. |
Tracks the user's events. For more detailed instructions, refer to the event tracking documentation.
parameter | type | required | description |
|---|---|---|---|
eventName |
| O | This is the name of the event to track,with a maximum length of 64 characters. |
eventProperty |
| X | This is additional information about the event. |
Sets the name of the screen along with user chat profile. If track is called before setPage, the event will not reflect the page information.
parameter | type | required | description |
|---|---|---|---|
page |
| X | This is the screen name when track is called. When calling |
profile |
| X | The user chat profile value. - When nil is assigned to a specific field within the profile object, only the value of that field is cleared. - The user chat profile value is applied when a user chat is created. |
Resets the name of the screen and user chat profile value set by setPage. The default page name is the name of the ViewController class that calls track.
Hides the Channel popup on the global screen.
Modifies user information.
parameter | type | required | description |
|---|---|---|---|
userData |
| O | This is the user information to be updated. |
completion |
| X | This returns the result of user information modification. |
Adds tags to the user.
parameter | type | required | description |
|---|---|---|---|
tags |
| O | • The maximum number of tags that can be added is 10. • Tags are stored in lowercase. • Any tags that have already been added will be ignored. • nil, empty strings, or lists containing them are not allowed. |
completion |
| X | When adding tags, it returns a CHTUser object. If the addition fails, it returns an error. |
Removes tags from the user, ignoring any tags that do not exist.
parameter | type | required | description |
|---|---|---|---|
tags |
| O | These are the tags to be removed.Null,empty strings,or lists containing them are not allowed. |
completion |
| X | When removing tags,it returns a |
Informs ChannelTalk about updates to the device token.
parameter | type | required | description |
|---|---|---|---|
deviceToken |
| O | This is the device token required for receiving push notifications. |
It checks if the push data should be processed by the SDK.
parameter | type | required | description |
|---|---|---|---|
_ |
| O | the userInfo object received through push notifications. |
Notifies Channel Talk that the user has received a push notification.
Stores push information on the device.
Check for any saved push notifications from the Channel.
Opens a user chat using the stored push information on the device through storePushNotifcation .
Verify that the SDK is in a Boot state.
Sets the debug mode. If set to true, log messages will be displayed.
Configures the SDK's theme.
parameter | type | required | description |
|---|---|---|---|
appearance | O | If specified as |
Renamed to setAppearance.
Sets the appearance of the SDK.
parameter | type | required | description |
|---|---|---|---|
appearance | O | If specified as |