ChannelIO

このページでは、チャネルトークReact Native SDK（以下、SDK）のChannelIOについて説明します。

boot

SDKを使用するために必要な情報を読み込みます。bootに成功すると、SDKの機能を利用できるようになります。詳細はこちらを参照してください。

パラメータ	タイプ	必須要件	説明
bootConfig	`object`	O	boot設定。プラグインキーやチャネルボタンの位置などを設定できる。
bootCallback	`((BootStatus, User?) -> Void)?`	X	boot状態とユーザー情報を返す。

JavaScript

sleep

システムプッシュ通知の受信と追跡を除く、すべての機能を無効にします。

JavaScript

shutdown

SDKとチャネル間の接続を終了します。shutdownを実行すると、SDKの機能が停止されます。

JavaScript

showChannelButton

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

JavaScript

hideChannelButton

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

JavaScript

showMessenger

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

JavaScript

hideMessenger

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

JavaScript

openChat

チャットを開きます。新しく開くか、既存のチャットを開くことができます。

パラメータ	タイプ	必須要件	説明
chatId	`string \| undefined`	X	チャットのID。chatIdが不正またはnilの場合、新しく作成されたチャットが開く。
message	`string \| undefined`	X	メッセージ入力欄に入力された状態のメッセージ。chatIdがnilの場合に有効になる。

JavaScript

openWorkflow

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

提供されたworkflowIdに対応するワークフローが存在する場合、そのワークフローが実行されます。workflowIdが無効な場合は、エラーページが表示されます。
workflowIdを渡さない場合、アクションは実行されません。

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

JavaScript

track

ユーザーのイベントを追跡します。詳細は「Event」をご参照ください。

パラメータ	タイプ	必須要件	説明
eventName	`string`	O	イベント名：最大64字
properties	`string \| undefined`	X	[任意] イベントプロパティ

パラメータ

タイプ

必須要件

説明

eventName

string

イベント名：最大64字

properties

string | undefined

[任意]

イベントプロパティ

JavaScript

updateUser

ユーザー情報を更新します。

パラメータ	タイプ	必須要件	説明
userData	`object`	O	更新されるユーザー情報

JavaScript

addTags

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

以前のユーザーのタグ	パラメータ	結果
["a"]["a"]	["b"]["b"]	["a", "b"]["a", "b"]
null	["a", "b"]["a", "b"]	["a", "b"]["a", "b"]
["a", "c"]["a", "c"]	["a", "b"]["a", "b"]	["a", "b", "c"]["a", "b", "c"]
["a", "b", "c", "d", "e", "f", "g"]["a", "b", "c", "d", "e", "f", "g"]	["g", "h", "i", "j"]["g", "h", "i", "j"]	["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"]["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"]
["a", "b", "c", "d", "e", "f", "g"]["a", "b", "c", "d", "e", "f", "g"]	["g", "h", "i", "j", "k"]["g", "h", "i", "j", "k"]	エラー：合計サイズは11

パラメータ	タイプ	必須要件	説明
tags	`string[]`	O	追加するタグ • 最大は10 • タグの重複不可 • タグは、大文字と小文字を区別しない（小文字に変換される） • null、nullを含むリスト、空のリスト、および空の文字列は許可されない

パラメータ

タイプ

必須要件

説明

removeTags

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

以前のユーザーのタグ	パラメータ	結果
["a", "b"]["a", "b"]	["a"]["a"]	["b"]["b"]
["a"]["a"]	["c"]["c"]	["a"]["a"]
["a"]["a"]	["A", "c"]["A", "c"]	null

パラメータ	タイプ	要件	説明
tags	`string[]`	O	削除するタグ。nil、空の文字列、またはそれらを含むリストは許可されない。

JavaScript

setPage

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

パラメータ	タイプ	要件	説明
page	`string \| null`	X	trackが呼び出された際の画面の名前。 .setPage(null)を呼び出すと、イベントのページ情報はnullに設定される。
profile	`object`	X	ユーザーチャットプロフィールの値。 • プロフィールオブジェクト内の特定のフィールドにnilが割り当てられた場合、そのフィールドの値のみが消去される。 • 接客チャットプロフィールの値は、ユーザーチャットが作成されるタイミングで適用される。

パラメータ

タイプ

要件

説明

page

string | null

trackが呼び出された際の画面の名前。

.setPage(null)を呼び出すと、イベントのページ情報はnullに設定される。

profile

object

ユーザーチャットプロフィールの値。

• プロフィールオブジェクト内の特定のフィールドにnilが割り当てられた場合、そのフィールドの値のみが消去される。

• 接客チャットプロフィールの値は、ユーザーチャットが作成されるタイミングで適用される。

JavaScript

resetPage

trackが呼び出された際の画面名をリセットします。デフォルト値は、trackを呼び出しているViewControllerまたはActivityの名前になります。

JavaScript

hidePopup

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

JavaScript

initPushToken

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

パラメータ	タイプ	必須要件	説明
token	`string`	O	プッシュトークン

JavaScript

isChannelPushNotification

プッシュ通知のペイロードがチャネルトークSDKを対象としているか確認します。

パラメータ	タイプ	必須要件	説明
payload	`object`	O

JavaScript

receivePushNotification

ユーザーがプッシュ通知を受信したというイベントを通知します。

＋Android プッシュ通知を表示します。

パラメータ	タイプ	必須要件	説明
payload	`object`	O

JavaScript

hasStoredPushNotification

プラグインに未処理のプッシュ通知があるか確認します。詳細はプッシュ通知のセクションをご参照ください。

パラメータ	説明	備考
activity	チャットを開始するためのベースとなるアクティビティ	Androidのみ

JavaScript

openStoredPushNotification

receivePushNotification によって保存されたプッシュデータに基づいて、チャットを開きます。

パラメータ	説明	備考
activity	チャットを開始するためのベースとなるアクティビティ	Androidのみ

JavaScript

isBooted

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

setDebugMode

SDKのデバッグモードを設定します。trueに設定すると、SDKはコンソールにログメッセージを出力します。

パラメータ	説明
flag	デバッグフラッグ

JavaScript

setAppearance

SDKの外観を設定します。

パラメータ	タイプ	要件	説明
appearance	`Appearance`	O	"light" または "dark" を指定すると、それぞれのプロパティでテーマを固定します。"system" を指定した場合は、デバイスのシステムテーマに従います。デフォルト値は "system" です。