Models

BootConfig

ChannelIO.boot()のオプションを設定します。

フィールド	タイプ	説明
pluginKey	`@NonNull` String	プラグインキー
memberId	`@Nullable` String	各ユーザーを識別するための識別子。メンバーユーザーとしてブートする方法を参照
memberHash	`@Nullable` String	memberIdのHMAC-SHA256値。メンバーハッシュの有効化を参照。`memberHash`がnullでない場合は、常に`memberId`も渡す必要がある。
profile	`@Nullable` Profile	ユーザーのプロフィール
language	`@Nullable` Language	ユーザーの言語。nullの場合、言語はデバイスの言語に設定される。
unsubscribeEmail	`@Nullable` Boolean	メールマーケティングメッセージの受信設定
unsubscribeTexting	`@Nullable` Boolean	SMSマーケティングメッセージの受信設定
trackDefaultEvent	`@NonNull` Boolean	PageViewなどのデフォルトイベントを追跡するか
hidePopup	`@NonNull` Boolean	マーケティングポップアップやアプリ内通知などのポップアップを非表示にするか
channelButtonOption	`@Nullable` ChannelButtonOption	チャネルボタンのオプション。チャネルボタンのカスタマイズを参照。
bubbleOption	`@Nullable` BubbleOption	マーケティングポップアップやアプリ内通知などのポップアップのオプション。ポップアップのカスタマイズを参照。
appearance	`@Nullable` Appearance	SDKが使用する外観のオプション

enum Language

チャネルトークがサポートしている言語は以下の通りです。

フィールド	説明
KOREAN	韓国語
JAPANESE	日本語
ENGLISH	英語

ChannelButtonIcon

チャネルボタン用のプリセットアイコンです。

Kotlin

ChannelButtonPosition

チャネルボタンの表示位置です。

Kotlin

ChannelButtonOption

チャネルボタンのオプションです。

<init>

フィールド	タイプ	説明
icon	ChannelButtonIcon	チャネルボタンのアイコンタイプ
position	ChannelButtonPosition	チャネルボタンの位置
xMargin	float	指定位置からのX軸のマージン（DP単位）
yMargin	float	指定位置からのY軸のマージン（DP単位）

フィールド	タイプ	説明
icon	ChannelButtonIcon	チャネルボタンのアイコンタイプ

フィールド	タイプ	説明
position	ChannelButtonPosition	チャネルボタンの位置
xMargin	float	指定位置からのX軸のマージン（DP単位）
yMargin	float	指定位置からのY軸のマージン（DP単位）

BubbleOption

マーケティングポップアップおよびアプリ内通知のオプションです。

フィールド	タイプ	説明
position	`@NonNull` BubblePosition	ポップアップの位置
yMargin	float	指定位置からのY軸のマージン（DP単位）

Profile

ユーザーのプロフィール。BootConfig#setProfile(Profile)をご参照ください。

プリミティブフィールド

フィールド	タイプ	説明
name	`@Nullable` String	ユーザーの名前
email	`@Nullable` String	ユーザーのメールアドレス
mobileNumber	`@Nullable` String	ユーザーの電話番号
avatarUrl	`@Nullable` String	ユーザーのアバターURL

setProperty

プロフィールのカスタムフィールドを設定します。

フィールド	タイプ	説明
propertyKey	`@NonNull` String	プロフィールのプロパティのキー
propertyValue	`@Nullable` Object	プロフィールのプロパティの値

setProperties

複数のプロフィールのプロパティを設定します。

User

フィールド	タイプ	説明
id	`@NonNull` String	ユーザーID
memberId	`@Nullable` String	会員ユーザーを識別するための識別子。匿名ユーザーの場合はnull。
name	`@Nullable` String	ユーザーの名前
avatarUrl	`@Nullable` String	ユーザーのアバターURL
profile	`@Nullable` Map<String, Object>	ユーザーのプロフィール
alert	int	重要な通知の数。デフォルトのチャネルボタンでは、バッジ内に数字として表示される。
unread	int	未読通知の数。これには`alert`の値も含まれる。デフォルトのチャネルボタンでは、点として表示される。
tags	`@Nullable` List	ユーザーのタグリスト
language	`@Nullable` String	ユーザーの言語
unsubscribeTexting	boolean	ユーザーがSMSまたはLMSのマーケティングメッセージの受信設定
unsubcribeEmail	boolean	ユーザーがメールマーケティングメッセージの受信設定

PopupData

onPopupDataReceivedのパラメータとして渡されるポップアップ情報のデータオブジェクトです。

フィールド	タイプ	説明
chatId	`@NonNull` String	メッセージに対応するユーザーチャットのID
avatarUrl	`@NonNull` String	メッセージ送信者のプロフィール画像のURL
name	`@NonNull` String	メッセージ送信者の名前
message	`@Nullable` String	メッセージの内容
timestamp	`@NonNull` long	メッセージが送信された時刻のUnixタイムスタンプ

UserData.Builder

新しいUserインスタンスを構築します。詳細についてはChannelIO.updateUser(UserData, UserUpdateCallback)をご参照ください。

setLanguage

ユーザーの言語を設定します。

フィールド	タイプ	説明
language	`@NonNull` Language	ユーザーの言語

setTags

ユーザーのタグリストを設定します。

フィールド	タイプ	説明
tags	`@Nullable` List	ユーザーのタグリスト

setProfileMap

ユーザーのプロフィール情報を設定します。

フィールド	タイプ	説明
tags	`@Nullable` List	ユーザーのタグリスト

setProfileOnceMap

プロフィールの情報が存在しない場合にのみ、ユーザーのプロフィール情報を設定します。

フィールド	タイプ	説明
profileOnceMap	`@Nullable` Map<String, Object>	ユーザーのプロフィール情報

setUnsubscribeEmail

ユーザーがメールマーケティングメッセージの受信解除をするかを設定します。

フィールド	タイプ	説明
unsubcribeEmail	`@NonNull` Boolean	ユーザーがメールマーケティングメッセージの受信解除（配信停止）を希望しているか

setUnsubcribeTexting

ユーザーがSMSまたはLMSのマーケティングメッセージの受信を解除（配信停止）するかを設定します。

フィールド	型	説明
unsubscribeTexting	`@NonNull` Boolean	ユーザーがSMSまたはLMSのマーケティングメッセージの受信解除（配信停止）を希望しているか

BootStatus

ChannelIO.boot()の実行結果です。

フィールド	説明
SUCCESS	ブートに成功
NOT_INITIALIZED	`ChannelIO.initialize()`が呼び出されていない
NETWORK_TIMEOUT	ネットワークの問題により、起動に失敗
NOT_AVAILABLE_VERSION	サポートされていないSDKバージョン
SERVICE_UNDER_CONSTRUCTION	チャネルトークのサーバーがメンテナンス中
REQUIRE_PAYMENT	チャネルがブロックされているか、サブスクリプションプランを確認する必要あり
ACCESS_DENIED	サーバーが4xxステータスコードを返却
UNKNOWN	不明なエラー

enum Appearance

SDKの外観設定です。

フィールド	説明
LIGHT	明るいテーマ
DARK	暗いテーマ
SYSTEM	システムテーマに従う