このページでは、チャネルトーク React Native SDK（以下、SDK）のモデルについて説明します。
ChannelIO.boot のオプションを設定します。このモデルは boot メソッドの引数として使用されます。具体的な使用例については、クイックスタートをご参照ください。
フィールド | タイプ | 説明 |
|---|---|---|
pluginKey |
| プラグインキー |
memberId | (optional) | 各ユーザーを識別するためのid |
memberHash | (optional) | memberIdのHMAC-SHA256値。メンバーハッシュの有効化を参照。 |
profile | (optional) | ユーザーのプロフィール |
language | (optional) | ユーザーの言語設定。新規ユーザー作成時に有効になる。既存ユーザーの言語設定は変更されない。 |
unsubscribeEmail | (optional) | メールによるマーケティングメッセージの受信設定 |
unsubscribeTexting | (optional) | テキストメッセージ（SMS、LMS）によるマーケティングメッセージの受信設定 |
trackDefaultEvent | (optional) | PageViewなどのデフォルトイベントを追跡するかの設定 |
hidePopup | (optional) | マーケティングポップアップやアプリ内通知などのポップアップを非表示にするかの設定 |
channelButtonOption | (optional) | チャネルボタンのオプション。ボタンの表示位置やマージンを設定できます。マージンの単位は pt（point）です。 |
bubbleOption | (optional) | 吹き出し型のマーケティングメッセージやアプリ内通知のポップアップに関するオプション。マージンの単位は pt（point）です。 |
appearance | SDKの外観を設定 |
SDKがサポートしている言語です。
チャネルボタンの表示位置を調整するためのオプションです。画面の左下、または右下に設定できます。デフォルトの位置はrightで、マージンはそれぞれ20に設定されています。
アプリ内メッセージおよび吹き出し型マーケティングメッセージの表示位置とマージンを設定します。位置のデフォルト値はtop、マージンのデフォルト値は20です。
チャネルボタンのアイコンの外観を設定します。
ユーザーのプロフィールです。
フィールド | 型 | 説明 |
|---|---|---|
name | (optional) | ユーザーの名前 |
(optional) | ユーザーのメールアドレス | |
mobileNumber | (optional) | ユーザーの電話番号 |
avatarUrl | (optional) | ユーザーのアバターURL |
チャネルトークSDKが導入されたWebサイトやアプリを訪問したユーザーです。
フィールド | タイプ | 説明 |
|---|---|---|
id |
| SDKで使用する固有の識別子 |
memberId | (optional) | メンバーユーザーを識別するための識別子。匿名ユーザーの場合はnullになる。 |
name | (optional) | ユーザーの名前 |
avatarUrl | (optional) | ユーザーのアバターURL |
profile | (optional) | ユーザーのプロフィール情報を含むオブジェクト |
alert |
| ユーザーがまだ読んでいない重要な通知の数。チャネルボタン上に数字で表示される。 |
unread |
| ユーザーが持っているすべての未読通知数。これにはalertの数も含まれる。チャネルボタン上に赤点で表示される。 |
tags | (optional) | ユーザーのタグリスト |
language | ユーザーの言語 | |
unsubscribeTexting | (optional) | メールによるマーケティングメッセージの受信設定 |
unsubscribeEmail | (optional) | テキストメッセージ（SMS、LMS）によるマーケティングメッセージの受信設定 |
アプリ内ポップアップに関するデータです。
フィールド | タイプ | 説明 |
|---|---|---|
chatId |
| ポップアップに関連付けられたチャットID |
avatarURL |
| ポップアップに表示されるアバターのURL |
name |
| ポップアップに表示される名前 |
message |
| ポップアップに表示されるメッセージ内容 |
updateUserのデータを設定する際に使用されるモデルです。
フィールド | タイプ | 説明 |
|---|---|---|
language | ユーザーの言語 | |
tags | (optional) | ユーザーのタグリスト。追加したタグデータで上書きされる。最大10個まで設定可能で、英文字の大文字/小文字は区別されない。 |
profile | (optional) | ユーザーのプロフィール情報。追加したプロフィールデータで上書きされる。値をnilに設定すると初期化される。 |
profileOnce | (optional) | ユーザーに追加するプロフィール情報。既存の項目がない場合は、新しいプロフィール値として追加される。 |
unsubscribeEmail | (optional) | メールによるマーケティングメッセージの受信設定 |
unsubscribeTexting | (optional) | テキストメッセージ（SMS、LMS）によるマーケティングメッセージの受信設定 |
SDK の外観を設定するための列挙型（enum）オブジェクトです。
SDK のboot結果を表す列挙型（enum）オブジェクトです。
フィールド | 説明 |
|---|---|
success | bootに成功 |
notInitialized |
|
networkTimeout | ネットワークの問題により、起動に失敗 |
notAvailableVersion | サポートされていないSDKバージョン |
serviceUnderConstruction | チャネルトークのサーバーがメンテナンス中 |
requirePayment | チャネルがブロックされているか、サブスクリプションプランを確認する必要あり |
accessDenied | サーバーが4xxステータスコードを返却 |
unknown | 不明なエラー |