Models

CHTBootConfig

ChannelIO.bootのオプションを設定します。このモデルはbootメソッドのパラメータとして使用されます。

フィールド	タイプ	説明
pluginKey	`String`	チャネルのプラグインキー
memberId	`String?`	各メンバーユーザーを識別するためのid
memberHash	`String?`	'memberId'のHMAC-SHA256値。詳細は「Member Hash」をご参照ください。
profile	`CHTProfile?`	ユーザーのプロフィール
language	`CHTLanguage?`	ユーザーの言語。新規ユーザー作成時に有効です。既存ユーザーの言語は変更されません。
unsubscribeEmail	`Bool?`	メールでマーケティングメッセージを受け取るかどうかを設定します。
unsubscribeTexting	`Bool?`	テキストメッセージ（SMS、LMS）でマーケティングメッセージを受け取るかどうかを設定します。
trackDefaultEvent	`Bool?`	PageViewなどのデフォルトイベントを追跡するかどうかを設定します。
hidePopup	`Bool?`	マーケティングポップアップやアプリ内通知などのポップアップを非表示にするかどうかを設定します。
channelButtonOption	`CHTChannelButtonOption?`	チャネルボタンのオプション。チャネルボタンの外観と位置を設定できます。マージンの単位はpt（point）です。
bubbleOption	`CHTBubbleOption?`	アプリ内に表示されるデフォルトのメッセージ通知、マーケティングの吹き出し型を設定します。マージンの単位はpt（point）です。
appearance	`CHTAppearance?`	SDKの外観を設定します。

CHTLanguage

SDKがサポートしている言語です。

Swift

Objective-C

CHTChannelButtonOption

チャネルボタンの外観と位置を設定します。

アイコンの外観はCHTChannelButtonIconを使用して設定でき、位置は右下または左下に設定可能です。位置のデフォルト値は.rightで、マージンのデフォルト値は各 20pt です。

Swift

Objective-C

フィールド	タイプ	説明
icon	`CHTChannelButtonIcon`	`チャネルボタン`の外観を設定します。デフォルト値は .channel です。（SDK >= 11.0.0）
position	`CHTChannelButtonPosition`	`チャネルボタン`の位置を設定します。デフォルト値は .right です。
xMargin	Float	`チャネルボタン`のX軸の基準マージンを設定します。単位は pt です。
yMargin	Float	`チャネルボタン`のY軸の基準マージンを設定します。単位は pt です。

CHTChannelButtonPosition

チャネルボタンの位置を設定します。

Swift

CHTBubbleOption

アプリ内メッセージおよび吹き出し型マーケティングメッセージの位置とマージンを設定します。位置はデフォルトでtopに、マージンはデフォルトで20に設定されています。

Plaintext

// Units of x and y are pt in iOS.
let bubbleOption = CHTBubbleOption(
  position: .top, // .top or .bottom
  yMargin: 0
)

Plaintext

// Units of x and y are pt in iOS.
  CHTBubbleOption *bubbleOption = [[CHTBubbleOption alloc] init];
  [bubbleOption setPosition:CHTBubblePostitionTop]; // CHTBubblePostitionTop or CHTBubblePostitionBottom
  [bubbleOption setYMargin:0];

CHTChannelButtonIcon

チャネルボタンアイコンの外観を設定します。

Swift

CHTProfile

ユーザーのプロフィールです。

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

CHTUser

チャネルが導入されたWebサイトやアプリを訪問したユーザーです。

フィールド	タイプ	説明
id	`String`	SDKで使用する固有の識別子
memberId	`String?`	ユーザーを区別するための識別子。匿名ユーザーの場合はnull。
name	`String?`	ユーザーの名前
avatarUrl	`String?`	ユーザーのアバターURL
profile	`[String: Any]?`	ユーザーのプロフィールを含むオブジェクト
alert	`Int`	ユーザーが未読の重要な通知の数。チャネルボタン上に数字で表示される。
unread	`Int`	ユーザーのすべての未読通知の数。`alert`の数を含む。チャネルボタン上に赤い点で表示される。
tags	`[String]?`	ユーザーのタグ
language	`CHTLanguage`	ユーザーの言語
unsubscribeTexting	`Bool`	メールでマーケティングメッセージを受け取るかを設定する。
unsubscribeEmail	`Bool`	テキストメッセージ（SMS、LMS）でマーケティングメッセージを受け取るかを設定する。

Swift

Objective-C

CHTPopupData

アプリ内ポップアップのデータです。

フィールド	タイプ	説明
chatId	`String`	ポップアップの対象となるチャットID
avatarUrl	`String`	ポップアップのアバターURL
name	`String`	ポップアップに表示される名前
message	`String`	ポップアップに表示されるメッセージ

Swift

Objective-C

CHTUserData

updateUserのデータ設定に使用されるモデルです。

フィールド	タイプ	説明
language	`CHTLanguage`	ユーザーの言語
tags	`[String]?`	ユーザーのタグ。追加したタグデータで上書きされる。最大数は20個で、大文字/小文字は区別しない。
profile	`[String: Any]?`	ユーザーのプロフィール。追加したプロフィールデータで上書きされる。値をnullに設定すると初期化される。
profileOnce	`[String: Any]?`	ユーザーに追加するプロフィール。値が存在しない場合は、新しいプロフィール値として追加される。
unsubscribeEmail	`Bool`	メールでマーケティングメッセージを受け取るかを設定する。
unsubscribeTexting	`Bool`	テキストメッセージ（SMS、LMS）でマーケティングメッセージを受け取るかを設定する。

例は以下の通りです。

Swift

Objective-C

CHTAppearance

SDKの外観を設定するためのenumオブジェクトです。

Swift

Plaintext

typedef SWIFT_ENUM(NSInteger, CHTAppearance, closed) {
  CHTAppearanceSystem = 0,
  CHTAppearanceLight = 1,
  CHTAppearanceDark = 2,
};

CHTBootStatus

boot結果に対するenumオブジェクトです。

フィールド	説明
success	`boot`成功
notInitialized	`ChannelIO.initialize()` が呼び出されていない
networkTimeout	ネットワークの問題により`ChannelIO.boot`失敗
notAvailableVersion	サポートされていないSDKバージョン
serviceUnderConstruction	チャネルトークのサーバーがメンテナンス中
requirePayment	チャネルがブロックされているか、有料プラン決済の確認が必要
accessDenied	サーバーが4xxステータスコードを返した
unknown	不明なエラー

Swift

Objective-C