Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

[in_app_purchase] Implementation of platform interface #3781

Merged
cyanglaz merged 17 commits into from
Apr 22, 2021
Merged

[in_app_purchase] Implementation of platform interface #3781

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
652e5d1
Draft implementation of platform interface
mvanbeusekom Apr 2, 2021
bcb9d38
Added finishPurchase and restorePurchase definitions
mvanbeusekom Apr 7, 2021
23230c9
Fix formatting and analysis warnings
mvanbeusekom Apr 7, 2021
8f17a42
Added missing license header
mvanbeusekom Apr 7, 2021
164700d
Fix analysis warnings
mvanbeusekom Apr 7, 2021
af8a388
Fix typo
mvanbeusekom Apr 7, 2021
a7693bd
Remove NoopInAppPurchase implementation
mvanbeusekom Apr 7, 2021
b80a3c6
Apply feedback from PR
mvanbeusekom Apr 8, 2021
12943f4
Removed obsolete PurchaseException
mvanbeusekom Apr 9, 2021
7ec5de6
Updated documentation per feedback
mvanbeusekom Apr 14, 2021
3ceef85
Fixed formatting
mvanbeusekom Apr 14, 2021
efc6120
Allow nullable instance
mvanbeusekom Apr 14, 2021
e7f6216
Updated readme to reflect setInstance method
mvanbeusekom Apr 14, 2021
24d305b
Removed platform specific comments
mvanbeusekom Apr 21, 2021
d86ac55
Add interfaces to support InAppPurchaseAddition
mvanbeusekom Apr 21, 2021
9eb358f
Document the addition functionality in README
mvanbeusekom Apr 22, 2021
33d1118
Added example code and documentation
mvanbeusekom Apr 22, 2021
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
Prev Previous commit
Next Next commit
Document the addition functionality in README
  • Loading branch information
@mvanbeusekom
mvanbeusekom committed Apr 22, 2021
commit 9eb358fee78102af78685b38da1a486861b1332c
9 changes: 8 additions & 1 deletion packages/in_app_purchase/in_app_purchase_platform_interface/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ platform-specific behavior, and when you register your plugin, set the default
`InAppPurchasePlatform` by calling
`InAppPurchasePlatform.setInstance(MyPlatformInAppPurchase())`.

Copy link
Contributor

@cyanglaz cyanglaz Apr 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also add doc for how to add additional features in a platform

Copy link
Contributor Author

@mvanbeusekom mvanbeusekom Apr 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

To implement functionality that is specific to the platform and is not covered
by the [`InAppPurchasePlatform`][2] idiomatic API, extend
[`InAppPurchasePlatformAddition`][3] with the platform-specific functionality,
and when the plugin is registered, set the addition instance by calling the
`InAppPurchasePlatformAddition.instance = MyPlatformInAppPurchaseAddition()`.

# Note on breaking changes

Strongly prefer non-breaking changes (such as adding a method to the interface)
Expand All @@ -23,4 +29,5 @@ See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
on why a less-clean interface is preferable to a breaking change.

[1]: ../in_app_purchase
[2]: lib/in_app_purchase_platform_interface.dart
[2]: lib/in_app_purchase_platform_interface.dart
[3]: lib/in_app_purchase_platform_addition.dart
4 changes: 2 additions & 2 deletions ...p_purchase/in_app_purchase_platform_interface/lib/in_app_purchase_platform_interface.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

export 'src/in_app_purchase_addition.dart';
export 'src/in_app_purchase_addition_provider.dart';
export 'src/in_app_purchase_platform.dart';
export 'src/in_app_purchase_platform_addition.dart';
export 'src/in_app_purchase_platform_addition_provider.dart';
export 'src/types/types.dart';
4 changes: 2 additions & 2 deletions ...ace/lib/src/in_app_purchase_addition.dart → ...rc/in_app_purchase_platform_addition.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// ignore: avoid_classes_with_only_static_members
/// The interface that platform implementations must implement when they want to
/// provide platform specific in_app_purchase features.
abstract class InAppPurchaseAddition {
abstract class InAppPurchasePlatformAddition {
/// The instance containing the platform specific in_app_purchase features.
Copy link
Contributor

@cyanglaz cyanglaz Apr 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a code example of how a platform can add "Addition".
Something like:

class InAppPurchaseSomeStoreAddition extends InAppPurchaseAddition {
    void someMethod() {}
}

class InAppPurchaseSomeStorePluginWeb {
    static void registerWith() {
         InAppPurchaseAddition = InAppPurchaseSomePlatformAddition();
     }
}

Copy link
Contributor Author

@mvanbeusekom mvanbeusekom Apr 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

static InAppPurchaseAddition? instance;
static InAppPurchasePlatformAddition? instance;
}
14 changes: 7 additions & 7 deletions ...rc/in_app_purchase_addition_provider.dart → ..._purchase_platform_addition_provider.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:in_app_purchase_platform_interface/src/in_app_purchase_addition.dart';
import 'package:in_app_purchase_platform_interface/src/in_app_purchase_platform_addition.dart';

/// The [InAppPurchaseAdditionProvider] is responsible for providing
/// a platform specific [InAppPurchaseAddition].
/// The [InAppPurchasePlatformAdditionProvider] is responsible for providing
/// a platform specific [InAppPurchasePlatformAddition].
///
/// [InAppPurchaseAddition] implementation contain platform specific
/// [InAppPurchasePlatformAddition] implementation contain platform specific
/// features that are not available from the platform idiomatic
/// [InAppPurchasePlatform] API.
abstract class InAppPurchaseAdditionProvider {
/// Provides a platform specific implementation of the [InAppPurchaseAddition]
abstract class InAppPurchasePlatformAdditionProvider {
/// Provides a platform specific implementation of the [InAppPurchasePlatformAddition]
/// class.
T getPlatformAddition<T extends InAppPurchaseAddition>();
T getPlatformAddition<T extends InAppPurchasePlatformAddition>();
}