initialize 関数はChannelIOを初期化する役割を担っており、ChannelIOの他のどのメソッドよりも前に呼び出される必要があります。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
application |
| Required | Applicationインスタンス |
attachView | boolean | true |
|
イベントが発生したときに呼び出されるコールバックを設定します。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
listener |
| Required | イベントが発生したときに呼び出されるリスナーインスタンス。nullの場合、リスナーは削除される。 |
setListenerによって以前に設定されたリスナーインスタンスを削除します。setListener(null)のショートカットです。
メッセンジャーやリアルタイムチャットの表示など、チャネル固有の機能の準備をします。チャネルトークの利用方法をご参照ください。bootCallbackパラメータを使用して、起動完了後に実行されるタスクを定義します。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
bootConfig |
| Required | boot設定。プラグインキーやチャネルボタンの位置などの値を設定できる。 |
bootCallback |
| null | bootが完了したときに呼び出されるコールバック |
機能の一部のみを使用したい場合はsleep()を、チャネルから完全に切断したい場合はshutdown()をそれぞれ使用してください。
ChannelIOがスリープ状態のとき、システムのプッシュ通知とtrackによるイベント追跡のみがアクティブなまま維持されます。リアルタイムチャットやマーケティングポップアップは表示されません。
boot()によって確立されたチャネルとの接続を終了します。shutdown()は、システムのプッシュ通知やイベント追跡を含むすべての機能を無効にします。システムのプッシュ通知やイベント追跡機能を保持したい場合は、sleep()をご参照ください。
例えば、ユーザーがサービスからサインアウトした場合、システムのプッシュ通知の受信を停止するためにshutdown()を実行するのが安全です。
関数が呼び出された後に表示されるActivityにチャネルボタンを表示します。
この関数は、boot()が完了する前に呼び出された場合でも効果を発揮します。これは、Channel Android SDKが「グローバルなボタン表示状態」を保持しており、boot()がその状態をリセットしないためです。
チャネルボタンを非表示にします。
メッセンジャーを表示します。チャネルボタンをカスタマイズしている場合、ボタンがクリックされたときにメッセンジャーを表示するためにこの関数を使用できます。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
activity |
| Required | Activityのインスタンス |
メッセンジャーを非表示にします。
チャットを開きます。showMessengerはメッセンジャーを開くのに対し、openChatは特定のチャットを開く点に注意してください。既存のチャットを開くだけでなく、新しいチャットを作成することもできます。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
activity |
| Required | Activityのインスタンス |
chatId |
| Required | 開くチャットのID。チャットIDがnullまたは無効な場合、新しいチャットが作成される。 |
message |
| Required | チャットが開いたときに入力されるメッセージ。これはchatIdがnullの場合にのみ有効。 |
代わりにopenWorkflowを使用してください。
サポートボットは現在サポートされておらず、ワークフローに置き換えられました。openSupportBotの動作はopenWorkflowと同じです。messageパラメータは無視されます。
特定のサポートボットを実行するためにユーザーチャットを開きます。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
activity |
| Required | Activityのインスタンス |
supportBotId |
| Required | サポートボットのID。IDがnullまたは無効な場合、チャットは閉じられる。 |
message |
| Required | 入力フィールドに入力されるメッセージ。supportBotIdが有効な場合にのみ機能する。 |
ユーザーチャットを開き、指定されたワークフローを開始します。
openWorkflowは、ワークフローのトリガーが「チャネルトーク経由でチャットを開始した時」に設定されている場合にのみ実行できます。提供された
workflowIdに対応するワークフローが存在する場合、それが実行されます。workflowIdが無効な場合は、エラーページが表示されます。workflowIdを渡さない場合、アクションは実行されません。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
workflowId |
| X | 開始するワークフローのID。そのようなワークフローが存在しない場合は、エラーページが表示される。 |
ユーザーのアクティビティに関するイベントを追跡します。詳細はイベントトラッキングをご参照ください。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
eventName |
| Required | イベントの名前 |
eventProperty |
| null | イベントの追加情報 |
eventPropertyパラメータはObject型ですが、JSON形式に変換可能な型である必要があります。そうでない場合、クラッシュを引き起こす可能性があります。特に、循環参照を含むオブジェクトを渡さないように注意してください。
ユーザーの情報を更新します。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
userData |
| Required | 更新されるユーザー情報 |
callback |
| Required | 更新が完了したときに呼び出されるコールバック |
ユーザーのタグを追加します。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
tags | vararg String | Required | 追加されるタグ • 最大長は10 • タグの重複は不可 • タグは、大文字と小文字を区別しない（小文字に変換されます） • null、nullを含むリスト、空のリスト、および空の文字列は許可されない |
callback |
| null | 更新が完了したときに呼び出されるコールバック |
ユーザーのタグを削除します。存在しないタグは無視されます。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
tags | vararg String | Required | 削除するタグ
|
callback |
| null | 更新が完了したときに呼び出されるコールバック |
イベントが追跡された際に表示されるページを設定します。デフォルトのページ名は現在アクティブなActivityの名前になります。ただし、Navigation Componentを使用したシングルActivityアーキテクチャを採用している場合など、デフォルトのページ名がユースケースに合わない状況では、より適切な情報を提供するためにページ名を手動で設定したい場合があります。
また、ユーザーチャットのプロフィールを設定することも可能です。
setPageの呼び出し以降に送信されるイベントに対して、設定したページが適用される点に注意してください。setPageを呼び出す前のすべてのイベントは影響を受けません。
setPage(null)とresetPage()の挙動は異なる点に留意してください。前者は明示的にページをnullに設定しますが、後者はページをデフォルト値にリセットします。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
page |
| null | 以後のイベントで表示されるページ。 pageパラメータがnullの場合、ページはnullとして記録される。 |
profile |
| null | 接客チャットのプロフィール値 • プロフィールオブジェクト内の特定のフィールドにnullが割り当てられた場合、そのフィールドの値のみが消去される。 • 接客チャットのプロフィール値は、ユーザーチャットが作成されるときに適用される。 |
setPageで設定されたページ名とユーザーチャットプロフィールを解除します。これ以降に送信されるイベントのページは、デフォルト値である Activity 名として記録されるようになります。
グローバル画面（アプリの全画面）のチャネルポップアップを非表示にします。
Firebase Cloud Messaging (FCM)トークンが変更されたことをチャネルトークSDKに通知します。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
token |
| Required | FCMトークン |
チャネルトークSDKが、そのプッシュデータの処理を担当しているかどうかを確認します。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
payload | Map<String,String> | Required | FCMから取得されたプッシュデータ。 |
システムプッシュ通知を表示し、ユーザーがプッシュ通知を受信したことをチャネルトークに通知します。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
context |
| Required | Contextのインスタンス |
payload | Map<String,String> | Required | FCMから取得されたプッシュデータ。 |
receivePushNotificationに渡されたプッシュデータが存在するかどうかを確認します。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
context |
| Required | Activityのインスタンス |
receivePushNotificationによって受信されたプッシュデータに基づいてチャット画面を開きます。プッシュ通知がクリックされたときに起動される Activity 内でこのメソッドを呼び出してください。
最新のbootが成功し、かつshutdownがまだ呼び出されていない状態かを確認します。
デバッグモードのオン／オフを切り替えます。trueに設定すると、ログメッセージが表示されるようになります。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
flag | boolean | Required | デバッグフラグ |
SDKの外観を設定します。
パラメータ | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
appearance | Appearance | Required | • LIGHT：明るいテーマ • DARK：暗いテーマ • SYSTEM：システム設定のテーマに従います。 |