Skip to content

Add doc comments to trackPurchase method #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 5, 2020
Merged

Add doc comments to trackPurchase method #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion lib/src/qonversion.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ class Qonversion {
/// Returns `userId` for Ads integrations.
///
/// **Warning**:
/// Qonversion will track any purchase events (trials, subscriptions, basic purchases) automatically.
/// On iOS Qonversion will track any purchase events (trials, subscriptions, basic purchases) automatically.
///
/// On Android you will have to call `Qonversion.trackPurchase(details, purchase)` method to track all
/// purchases manually.
static Future<String> launch({
@required String androidApiKey,
@required String iosApiKey,
Expand All @@ -39,8 +42,18 @@ class Qonversion {
return uid;
}

/// Tracks purchases manually on Android.
///
/// Returns `null` if `!Platform.isAndroid`.
///
/// You can use [official in_app_purchase package](https://pub.dev/packages/in_app_purchase) and its
/// [SkuDetailsWrapper](https://github.com/flutter/plugins/blob/master/packages/in_app_purchase/lib/src/billing_client_wrappers/sku_details_wrapper.dart)
/// and [PurchaseWrapper](https://github.com/flutter/plugins/blob/master/packages/in_app_purchase/lib/src/billing_client_wrappers/purchase_wrapper.dart)
/// to pass [details] and [purchase] arguments.
Future<String> trackPurchase(
Map<String, dynamic> details, Map<String, dynamic> purchase) async {
if (!Platform.isAndroid) return null;

final args = {
Constants.kDetails: details,
Constants.kPurchase: purchase,
Expand Down