ChannelIO

initialize

パラメータ	タイプ	必須要件	説明
application	`UIApplication`	O	Applicationクラスのインスタンス

ChannelIO オブジェクトを初期化します。他のすべてのChannelIOメソッドを利用する前に、このメソッドを少なくとも一度は呼び出す必要があります。

Swift

Objective-C

initializeWindow

SceneDelegateを使用している場合にこのメソッドが必要になります。このメソッドはUIWindowSceneを用いてChannelWindowを返します。

ChannelIO 用のクラス変数を宣言してください。以下の例では、変数名をChannelWindowとしています。

パラメータ	タイプ	必須要件	説明
windowScene	`UIWindow`	O	UIWindowScene クラスのインスタンス

Swift

Objective-C

delegate

ChannelIOのためのデリゲートオブジェクトです。

Swift

Objective-C

boot

SDKの使用に必要な情報を読み込みます。bootに成功すると、チャネルトークの機能を利用する準備が整います。詳細については、bootセクションを参照してください。

パラメータ	タイプ	必須要件	説明
config	`CHTBootConfig`	O	`boot`用の設定オブジェクト。 `pluginKey`の設定や、`チャネルボタン`の位置のカスタマイズ、その他のオプションを設定できる。
completion	`((CHTBootStatus, CHTUser?) -> Void)?`	X	`boot`からのコールバック。 bootStatusとUserオブジェクトを返す。

パラメータ

タイプ

必須要件

説明

config

CHTBootConfig

boot用の設定オブジェクト。

pluginKeyの設定や、チャネルボタンの位置のカスタマイズ、その他のオプションを設定できる。

completion

((CHTBootStatus, CHTUser?) -> Void)?

bootからのコールバック。

bootStatusとUserオブジェクトを返す。

Swift

Objective-C

sleep

システムプッシュ通知の受信とTrack機能を除く、すべての機能を無効化します。チャネルトークのサーバーとのソケット通信が切断されるため、チャットやマーケティングポップアップなどのリアルタイム機能は利用できなくなります。

Swift

Objective-C

shutdown

SDKをチャネルから切断します。SDKのすべての機能の使用が中断されます。

Swift

Objective-C

showChannelButton

グローバル画面（アプリの全画面）にチャネルボタンを表示します。

Swift

Objective-C

hideChannelButton

グローバル画面（アプリの全画面）上でチャネルボタンを非表示にします。

Swift

Objective-C

showMessenger

メッセンジャーを表示します。

Swift

Objective-C

hideMessenger

メッセンジャーを非表示にします。

Swift

Objective-C

openChat

ユーザーチャットを開きます。指定した chatId が存在する場合はそのチャットを開き、存在しない場合は新しいチャットを開始します。

パラメータ	タイプ	必須要件	説明
chatId	`String?`	X	チャットの固有ID。このchatIdが無効であるかnilの場合は、新しいユーザーチャットが開かれる。
message	`String?`	X	新しいチャットを開く際、メッセージ入力欄にあらかじめ入力されるテキスト。これはchatIdがnilの場合にのみ有効となります。

Swift

Objective-C

openSupportBot deprecated

非推奨：代わりにopenWorkflowを使用してください

サポートボット機能はサポートを終了し、ワークフローに置き換えられました。openSupportBotの動作はopenWorkflowと同じです。なお、このメソッドではmessageパラメータは無視されます。

特定のサポートボットを実行するために、接客チャットを開きます。

パラメータ	タイプ	必須要件	説明
supportBotId	`String?`	X	サポートボットの固有ID。このsupportBotIdが無効であるかnilの場合、チャットルームは閉じられる。
message	`String?`	X	サポートボットの操作が完了した後、メッセージ入力欄に表示されるテキスト。

Swift

Objective-C

openWorkflow

接客チャットを開き、指定されたワークフローを開始します。

openWorkflow は、ワークフローのトリガーが「チャネルトークからチャットを開始した時」に設定されている場合にのみ実行できます。
提供された workflowId に該当するワークフローが存在すれば、それが実行されます。workflowId が無効な場合は、エラーページが表示されます。
workflowId を渡さない場合、アクションは実行されません。

パラメータ	タイプ	必須要件	説明
workflowId	`String?`	X	開始するワークフローのID。該当するワークフローが存在しない場合は、エラーページが表示される。

Swift

Objective-C

track

ユーザーのイベントを追跡（track）します。詳細な手順については、Eventのドキュメントをご参照ください。

パラメータ	タイプ	必須要件	説明
eventName	`String`	O	追跡するイベントの名前。最大64文字まで設定可能。
eventProperty	`[String: Any]?`	X	イベントに関する追加情報（プロパティ）。

Swift

Objective-C

setPage

ユーザーチャットのプロフィールと共に、画面の名前を設定します。setPage を呼び出す前に track が実行された場合、そのイベントにはページ情報が反映されません。

パラメータ	タイプ	必須要件	説明
page	`String?`	X	track が呼び出された際の画面名。`.setPage(nil)`を呼び出すと、イベントのページ情報は`null`に設定される。
profile	`[String: Any]`	X	接客チャットのプロフィール値。プロフィールオブジェクト内の特定のフィールドに nil を代入すると、そのフィールドの値のみが消去される。このプロフィール値は、接客チャットが作成されるタイミングで適用される。

パラメータ

タイプ

必須要件

説明

page

String?

track が呼び出された際の画面名。.setPage(nil)を呼び出すと、イベントのページ情報はnullに設定される。

profile

[String: Any]

接客チャットのプロフィール値。

プロフィールオブジェクト内の特定のフィールドに nil を代入すると、そのフィールドの値のみが消去される。
このプロフィール値は、接客チャットが作成されるタイミングで適用される。

Swift

Objective-C

resetPage

setPageで設定された画面名と接客チャットのプロフィール値をリセットします。デフォルトのページ名は、trackを呼び出した ViewController クラスの名前になります。

Swift

Objective-C

hidePopup

グローバル画面（アプリの全画面）上でチャネルトークのポップアップを非表示にします。

Swift

Objective-C

updateUser

ユーザー情報を修正します。

パラメータ	タイプ	必須要件	説明
userData	`[String: Any?]`	O	更新対象となるユーザー情報。
completion	`((Bool, CHTUser?) -> Void)?`	X	ユーザー情報の変更結果を返す。

Swift

Objective-C

addTags

ユーザーにタグを追加します。

パラメータ	タイプ	必須要件	説明
tags	`[String]`	O	• 追加できるタグの最大数は10個。 • タグは小文字で保持される。 • すでに追加されているタグは無視される。 • nil、空文字列、またはそれらを含むリストは許可されない。
completion	`((Error?, CHTUser?) -> Void)?`	X	タグの追加に成功すると CHTUser オブジェクトを返し、失敗した場合はエラーを返す。

パラメータ

タイプ

必須要件

説明

removeTags

ユーザーからタグを削除します。存在しないタグを指定した場合は無視されます。

パラメータ	タイプ	必須要件	説明
tags	`[String]`	O	削除するタグのリスト。nil、空文字列、またはそれらを含むリストを渡すことはできない。
completion	`((Error?, CHTUser?) -> Void)?`	X	タグの削除に成功すると、更新された情報を持つ`CHTUser`オブジェクトを返す。削除に失敗した場合は、エラーを返す。

Swift

Objective-C

initPushToken

デバイストークンの更新をチャネルトークに通知します。

パラメータ	タイプ	必須要件	説明
deviceToken	`Data`	O	プッシュ通知を受信するために必要なデバイストークン。

Swift

Objective-C

isChannelPushNotification

そのプッシュ通知データが、チャネルトークのSDKによって処理されるべきものかどうかを確認します。

パラメータ	タイプ	必須要件	説明
_	`[AnyHashable: Any]`	O	プッシュ通知を介して受け取った userInfo オブジェクト。

Swift

Objective-C

receivePushNotification

ユーザーがプッシュ通知を受信したことをチャネルトークに通知します。

Swift

Objective-C

storePushNotification

プッシュ通知の情報をデバイスに保存します。

Swift

Objective-C

hasStoredPushNotification

デバイスに保存されているチャネルトークからのプッシュ通知があるかを確認します。

Swift

Objective-C

openStoredPushNotification

storePushNotification を通じてデバイスに保存されたプッシュ通知情報を使用して、接客チャット画面を開きます。

Swift

Objective-C

isBooted

SDKがboot状態であることを確認します。

Swift

Objective-C

setDebugMode

デバッグモードを設定します。true に設定すると、コンソールにログメッセージが表示されます。

Swift

Objective-C

setAppearance

SDKのテーマ（外観）を設定します。

パラメータ	タイプ	必須要件	説明
appearance	`CHTAppearance`	O	`.light`または`.dark`を指定すると、テーマをそれぞれのモードに固定する。`.system`を指定した場合は、デバイスのシステム設定に従う。

Swift

Objective-C

applyAppearance deprecated

メソッド名がsetAppearanceに変更されました。

SDK の外観を設定するために使用します。

パラメータ	タイプ	必須要件	説明
appearance	`CHTAppearance`	O	`.light`または`.dark`を指定すると、テーマをそれぞれのモードに固定する。`.system`を指定した場合は、デバイスのシステム設定に従う。

Swift

Objective-C