Promotion Overlay plugin #

Wraps a platform-specific promotional overlay banner (SKOverlay on iOS and macOS, TODO on Android, etc.).

Usage #

To use this plugin, add promotion_overlay as a dependency in your pubspec.yaml file.

Instantiating the PromotionOverlay object #

You must then specify the following parameters:

• appIdentifier (required, The iTunes identifier of the recommended app. (iOS))
• campaignToken (optional, A token you use to represent an ad campaign and measure its effectiveness. (iOS))
• providerToken (optional, A token that represents the provider of an app promotion campaign, and that you use to measure the campaign’s effectiveness. (iOS))
• dismissOnBackground (optional, default: true, A Boolean value that indicates whether the overlay is dismissed when the user switches to another app. (iOS))
• position (optional, default: .bottom, The position of the overlay on the screen.)

How to use #

// Create an overlay instance
final PromotionOverlay promotionOverlay = PromotionOverlay('identifier',
        campaignToken: 'campaignToken', providerToken: 'providerToken');

// Show the promotion overlay
final promotionOverlay = await promotionOverlay.show();
// Dismiss the promotion overlay
promotionOverlay.dismiss();

Testing #

This is still todo.

Overlay by platform #