この資料では、Pendo Flutter SDKの公開APIについて説明します。
Pendoクラスの公開API - SDKバージョン2.20以降
| 戻り型 | 公開APIメソッド - Dart | 説明 |
| Future<void> | setDebugMode(bool isDebugEnabled) |
Pendo SDKからのデバッグログを有効/無効にします。 このAPIはコードのどこからでも呼び出すことができ、startSessionが呼び出された後に有効になります。 |
Pendoクラスの公開API - SDKバージョン2.12以降
| 戻り型 | 公開APIメソッド - Dart | 説明 |
| static PendoFlutterPlugin | PendoFlutterPlugin | PendoFlutterPluginの共有インスタンスを返却します。 |
| Future<void> | setup(String appKey, [Map<String, dynamic>?appParams]) |
Pendo SDKを初期化します。アプリケーションのメインファイル（lib/main.dart）で当該APIを呼び出します。 このAPIは、将来のバージョンで非推奨になるinitSDKおよびinitSDKWithoutVisitorの代わりに使用する必要があります。 |
| Future<void> | startSession(String visitorId, String accountId, Map<String, dynamic>?visitorData, Map<String, dynamic>?accountData) |
提供された訪問者情報とアカウント情報でモバイルセッションを開始します。セッションがすでに進行中の場合、セッションは終了し、新しいセッションが開始されます。 匿名の訪問者を生成するには、visitorIdとしてnullを渡します。 このAPIは、将来のバージョンで非推奨になるswitchVisitorの代わりに使用する必要があります。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| Future<void> | endSession() |
アクティブなセッションを終了し、アナリティクスの収集やユーザーへのガイドの表示を停止します。詳細はこちらをご覧ください。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| Future<void> | clearVisitor() |
アクティブなセッションを終了して、匿名の訪問者との新しいセッションを開始します。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| Future<void> | setVisitorData(Map<String, dynamic> visitorData) |
訪問者のメタデータを更新します。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| Future<void> | setAccountData(Map<String, dynamic> accountData) |
アカウントのメタデータを更新します。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| Future<String?> | getVisitorId() | プロパティ：アクティブなセッションに参加している訪問者IDを返します。 |
| Future<String?> | getAccountId() | プロパティ：アクティブなセッションに参加しているアカウントIDを返します。 |
| Future<void> | setAccountId(String accountId) | プロパティ：アクティブなセッションに参加しているアカウントIDを設定します。 |
| Future<void> | track(String event, Map<String, dynamic> properties) |
指定したプロパティを持つトラックイベントを送信します。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| Future<void> | dismissVisibleGuides() | ガイドの表示をすべて閉じます。 |
| Future<void> | pauseGuides(bool dismissGuides) |
アクティブなセッションで表示されているガイドを一時停止します。dismissGuidesがTRUEの場合、表示されているガイドはすべて閉じられます。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
|
Future<void> |
resumeGuides() |
アクティブなセッションでガイドの表示を再開します。pauseGuidesの後でのみ使用できます。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| Future<String?> | getDeviceId() | Pendoが生成したデバイス固有のIDを返します。デバイスIDは、Pendoが匿名の各訪問者に対して一意のIDを生成するために使用されます。このIDは、アプリケーションごとに固有です。 |
SDKのインストール
Pendo Flutter SDKのインストール方法は、開発者サイトで確認できます。