カテゴリー
APIリファレンス
Boot Option
このドキュメントでは、bootのパラメータとしてのBoot Optionについて説明します。 使用例については、「クイックスタート」をご参照ください。 必須のオプション pluginKey タイプ 説明 string ご自身のチャネルのプラグインキー 任意のオプション memberId タイプ 説明 string Member userのID customLauncherSelector タイプ 説明 string カスタムランチャーを選択するためのCSSセレクター デフォルトのチャットボタンをカスタマイズする場合に、このオプションを使用します。 hideChannelButtonOnBoot タイプ 説明 boolean 起動時にデフォルトのチャットボタンを非表示にするかどうかを決定します。 デフォルト値はfalse です。 zIndex タイプ 説明 number チャットボタン、メッセンジャー、マーケティングポップアップなどのSDK要素のz-indexを設定します。 デフォルト値は10000000です。 language タイプ 説明 string ('en' | 'ko' |
ChannelIO
boot SDKの初期化を行います。 チャネルボタンが表示され、マーケティングポップアップなどの機能が利用可能な状態になります。 詳細については、bootをご参照ください。 ChannelIO('boot', bootOption: object, callback?: Function) パラメータ タイプ 説明 bootOption object SDKを初期化するためのBoot Option callback (optional) Function bootの後に実行されるコールバック関数。 bootに失敗した場合、コールバックは第1引数としてエラーオブジェクトを、第2引数としてnullを受け取ります。 bootに成功した場合、コールバックは第1引数としてnullを、第2引数としてUser Objectを受け取ります。 ChannelIO('boot', { pluginKey: 'YOUR_PLUGIN_KEY' }, function onBoot(error, user) { if (error) { console.error(error); } else { conso
User Object
このドキュメントでは、User Objectについて説明します。 詳細については、User Objectの例をご参照ください。 id タイプ 説明 string ユーザーのID memberId メンバーユーザーを作成するには、memberIdを使用する必要があります。 Boot OptionおよびbootにおけるmemberIdを参照してください。 タイプ 説明 string Member userを識別するために使用されるID。 Boot OptionでmemberIdが指定されている場合、そのユーザーはメンバーユーザーとみなされます。 name タイプ 説明 string | undefined ユーザーの名前 updateUserを介して設定されます。 avatarUrl タイプ 説明 string ユーザーのアバター画像のURL unread タイプ 説明 number ユーザーの未読通知の総数。 これにはアラートの数も含まれます。チャネルボタン上に赤い点が表示されます。 alert タイプ 説明 number ユーザーにとって重要な未読通知の数。 チャネルボタン上に数字とし
Legacy
このドキュメントでは、すでにサポートされていない、または間もなくサポートが終了するSDKについて説明します。 この文書に記載されたLegacy SDKは使用しないことを推奨します。 Legacy SDKはサポートが中断される可能性があり、それによりエラーが発生する場合があります。 もし既に使用中のSDKがある場合は、該当するSDKのマイグレーションガイドを参照し、速やかに交換することを推奨します。 ChannelIO show メッセンジャーを開きます。 ChannelIO('show'); マイグレーションガイド showMessengerを使用します。 hide メッセンジャーを閉じます。 ChannelIO('hide'); マイグレーションガイド hideMessengerを使用します。 lounge ホームへ移動します。 ChannelIO('lounge'); openSupportBot 該当のAPIは廃止になりました。openWorkflow APIをご使用ください。 サポートボットのサポート終了に伴い、該当のAPIは非推奨となり、openWorkflow SDK AP