チャネルトークReact Native SDKは、React Nativeアプリケーションにチャネルトークを簡単に導入できるプラグインです。WebViewやモバイルWebにインストールする場合は、JavaScript SDKインストールガイドをご参照ください。
シェルで以下のコマンドを実行して、SDKをインストールしてください。
本SDKには、モバイルSDKと互換性のあるバージョンのリストが含まれています。インストールしたバージョンが互換性を持っているか確認するには、バージョンの互換性をご参照ください。
SDKはCocoaPodsまたはCarthageを通じてインストールできます。
CocoaPodsを使用してチャネルトーク iOS SDK をインストールできます。インストールの最小要件は以下の通りです：
Xcode 12 以降
CocoaPods 1.10.0 以降
If it is already installed, run the
pod update.Podfileがあるディレクトリでpod installコマンドを実行し、パッケージをインストールします。すでにインストール済みの場合は、pod update を実行してください。Project_Name.xcworkspaceを開きます。
Carthageを利用してチャネルトーク iOS SDK をインストールできます。
以下のように、プロジェクトの
Cartfileに ChannelIOSDK を追加します。
特定のパッケージバージョンをインストールする必要がある場合は、適宜スクリプトを修正してください。
Cartfileがあるディレクトリでcarthage updateコマンドを実行し、パッケージをインストールします。例：
carthage update -platform iOS --use-xcframeworksChannelIOSDKパッケージは、
PROJECT_DIR/Carthage/buildディレクトリ内にビルドされます。このパッケージをXcodeにドラッグして追加してください。
いくつかの追加設定が必要です。
SDKを使用するには以下の権限が必要です。プロジェクトのInfo.plistに、以下のキー値と説明を追加してください。
キー | 値 |
|---|---|
Privacy-Camera Usage Description | より良いユーザー体験を提供するためにカメラにアクセス |
Privacy-Photo Library Additions Usage Description | 写真を保存するためにフォトライブラリにアクセス |
Privacy-Microphone Usage Description | 動画用の音声を録音するためにマイクにアクセス |
SDKを使用するための初期化設定を行います。
AppDelegate.swiftに移動し、以下のinitializeメソッドを追加してください。
もしSceneDelegate.swiftでウィンドウのインスタンスを管理している場合は、以下に示すようにinitializeWindowを追加する必要があります。
AppDelegate.mに移動し、以下のinitializeメソッドを追加してください。
もし SceneDelegate.m でウィンドウのインスタンスを管理している場合は、以下に示すように initializeWindow を追加する必要があります。
build.gradleに当社のMavenリポジトリを宣言してください。
ビルドエラーが発生した場合は、アプリレベルのbuild.gradleに依存関係を追加してください。
dependencies {
implementation 'io.channel:plugin-android'
}チャネルトーク SDKを使用するには、Application#onCreate()内でChannelIO.initialize()を呼び出す必要があります。
アプリのApplicationを別途作成していない場合は、新しく作成してください。
プロジェクトで使用されている言語に基づき、以下のコードを追加してください。
Android APIレベル28以上では、デフォルトで安全でないHTTP接続が禁止されています。会話中にHTTPのURLが送信された場合、SDKに組み込まれたWebViewはそのWebページを表示することができません。この問題を解決する最善の方法は、一貫してHTTPSのURLを送信することです。ただし、チームでHTTPのURLを送信する必要がある場合は、AndroidManifest.xmlのプロパティを次のように変更してください。
SDKを使用する予定の場所で、SDKをインポートしてください。
bootは、SDKを使用するための準備プロセスです。 チャネルのプラグインキーが必要になる場合があります。プラグインキーの取得方法をご確認ください。bootには匿名ユーザーとしてのbootとメンバーユーザーとしてのbootの２種類があります。ユーザーの詳細な説明については、「Member User」をご参照ください。
匿名ユーザーとは、memberIdを持たないユーザーのことです。以下は、匿名ユーザーでのbootの例と、bootの結果値を受け取る方法です。
メンバーユーザーとは、memberIdプロパティを持つユーザーのことです。自分のサービスにサインインしている場合など、ユーザーを個別に識別できる場合は、memberIdを提供することでメンバーユーザーとしてbootできます。チャネルはmemberIdフィールドによってユーザーを区別します。
ユーザーの機密情報を保護するためにメンバーハッシュを使用してください。
ユーザーIDやメールアドレスなどの推測可能な値を使用してmemberIdを設定すると、権限のない第三者がユーザーのmemberIdを取得する可能性があります。不正アクセスにより、悪意のある第三者が携帯電話番号やチャット履歴を含むユーザーの機密情報を入手し、セキュリティ侵害につながる恐れがあります。セキュリティレベルを向上させるために、チャネルのメンバーハッシュを有効化してください。
以下は、特定のmemberIdを持つメンバーユーザーをbootする例です。
注意事項
ChannelIO.showMessengerやChannelIO.showChannelButtonなど、SDK画面を表示する関数を、boot状態を確認して選択的に呼び出さないでください。
SDKはこれらの機能について、内部的にboot状態を確認します。バージョン 0.11.11 以降、将来のアップデートにより現在のSDKバージョンがサポート対象外となった場合、SDKはユーザーに対して適切な案内画面を自動的に表示します。これらの関数を選択的に呼び出してしまうと、この必要なユーザー体験が提供されず、サポートされていないバージョンを使用している顧客の体験を損なう可能性があります。
SDKは、メッセンジャーを起動するためのデフォルトのチャネルボタンを提供しています。showChannelButtonおよびhideChannelButtonを呼び出すことで、チャネルボタンを表示または非表示にできます。
ボタンの外観を変更したい場合は、チャネルボタンのカスタマイズをご参照ください。
trackを介したイベントトラッキング、またはプッシュ通知のみを利用したい場合に使用できます。チャットサポートやマーケティングポップアップなどの機能は動作しません。
SDKのすべての機能を終了します。SDKの機能を再度使用したい場合は、もう一度bootする必要があります。