add base platform interface classes

packages/interactive_media_ads/lib/src/platform_interface/interactive_media_ads_platform.dart

@@ -0,0 +1,73 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:plugin_platform_interface/plugin_platform_interface.dart';
+
+import 'platform_ad_display_container.dart';
+import 'platform_ads_loader.dart';
+import 'platform_ads_manager.dart';
+import 'platform_ads_manager_delegate.dart';
+
+/// Interface for a platform implementation of the Interactive Media Ads SDKs.
+abstract class InteractiveMediaAdsPlatform extends PlatformInterface {
+  /// Creates a new [InteractiveMediaAdsPlatform].
+  InteractiveMediaAdsPlatform() : super(token: _token);
+
+  static final Object _token = Object();
+
+  static InteractiveMediaAdsPlatform? _instance;
+
+  /// The instance of [InteractiveMediaAdsPlatform] to use.
+  static InteractiveMediaAdsPlatform? get instance => _instance;
+
+  /// Platform-specific plugins should set this with their own platform-specific
+  /// class that extends [InteractiveMediaAdsPlatform] when they register
+  /// themselves.
+  static set instance(InteractiveMediaAdsPlatform? instance) {
+    if (instance == null) {
+      throw AssertionError(
+        'Platform interfaces can only be set to a non-null instance',
+      );
+    }
+
+    PlatformInterface.verify(instance, _token);
+    _instance = instance;
+  }
+
+  /// Creates a new [PlatformAdsManager].
+  PlatformAdsManager createPlatformAdsManager(
+    PlatformAdsManagerCreationParams params,
+  ) {
+    throw UnimplementedError(
+      'createPlatformAdsManager is not implemented on the current platform.',
+    );
+  }
+
+  /// Creates a new [PlatformAdsLoader].
+  PlatformAdsLoader createPlatformAdsLoader(
+    PlatformAdsLoaderCreationParams params,
+  ) {
+    throw UnimplementedError(
+      'createPlatformAdsLoader is not implemented on the current platform.',
+    );
+  }
+
+  /// Creates a new [PlatformAdsManagerDelegate].
+  PlatformAdsManagerDelegate createPlatformAdsManagerDelegate(
+    PlatformAdsManagerDelegateCreationParams params,
+  ) {
+    throw UnimplementedError(
+      'createPlatformAdsManagerDelegate is not implemented on the current platform.',
+    );
+  }
+
+  /// Creates a new [PlatformAdDisplayContainer].
+  PlatformAdDisplayContainer createPlatformAdDisplayContainer(
+    PlatformAdDisplayContainerCreationParams params,
+  ) {
+    throw UnimplementedError(
+      'createPlatformAdDisplayContainer is not implemented on the current platform.',
+    );
+  }
+}

packages/interactive_media_ads/lib/src/platform_interface/platform_ad_display_container.dart

@@ -0,0 +1,80 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/foundation.dart';
+import 'package:plugin_platform_interface/plugin_platform_interface.dart';
+
+import 'interactive_media_ads_platform.dart';
+
+/// Object specifying creation parameters for creating a
+/// [PlatformAdDisplayContainer].
+///
+/// Platform specific implementations can add additional fields by extending
+/// this class.
+///
+/// This example demonstrates how to extend the
+/// [PlatformAdDisplayContainerCreationParams] to provide additional platform
+/// specific parameters.
+///
+/// When extending [PlatformAdDisplayContainerCreationParams] additional
+/// parameters should always accept `null` or have a default value to prevent
+/// breaking changes.
+///
+/// ```dart
+/// class AndroidPlatformAdDisplayContainerCreationParams
+///     extends PlatformAdDisplayContainerCreationParams {
+///   AndroidPlatformAdDisplayContainerCreationParams._(
+///     PlatformAdDisplayContainerCreationParams params, {
+///     this.uri,
+///   }) : super();
+///
+///   factory AndroidAdDisplayContainerCreationParams.fromPlatformAdDisplayContainerCreationParams(
+///     PlatformAdDisplayContainerCreationParams params, {
+///     Uri? uri,
+///   }) {
+///     return AndroidAdDisplayContainerCreationParams._(params, uri: uri);
+///   }
+///
+///   final Uri? uri;
+/// }
+/// ```
+@immutable
+class PlatformAdDisplayContainerCreationParams {
+  /// Used by the platform implementation to create a new [PlatformAdDisplayContainer].
+  const PlatformAdDisplayContainerCreationParams();
+}
+
+/// Interface for a platform implementation of a `AdDisplayContainer`.
+abstract class PlatformAdDisplayContainer extends PlatformInterface {
+  /// Creates a new [PlatformAdDisplayContainer]
+  factory PlatformAdDisplayContainer(
+    PlatformAdDisplayContainerCreationParams params,
+  ) {
+    assert(
+      InteractiveMediaAdsPlatform.instance != null,
+      'A platform implementation for `interactive_media_ads` has not been set. '
+      'Please ensure that an implementation of `InteractiveMediaAdsPlatform` '
+      'has been set to `InteractiveMediaAdsPlatform.instance` before use. For '
+      'unit testing, `InteractiveMediaAdsPlatform.instance` can be set with '
+      'your own test implementation.',
+    );
+    final PlatformAdDisplayContainer implementation =
+        InteractiveMediaAdsPlatform.instance!
+            .createPlatformAdDisplayContainer(params);
+    PlatformInterface.verify(implementation, _token);
+    return implementation;
+  }
+
+  /// Used by the platform implementation to create a new [PlatformAdDisplayContainer].
+  ///
+  /// Should only be used by platform implementations because they can't extend
+  /// a class that only contains a factory constructor.
+  @protected
+  PlatformAdDisplayContainer.implementation(this.params) : super(token: _token);
+
+  static final Object _token = Object();
+
+  /// The parameters used to initialize the [PlatformAdDisplayContainer].
+  final PlatformAdDisplayContainerCreationParams params;
+}

packages/interactive_media_ads/lib/src/platform_interface/platform_ads_loader.dart

@@ -0,0 +1,78 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/foundation.dart';
+import 'package:plugin_platform_interface/plugin_platform_interface.dart';
+
+import 'interactive_media_ads_platform.dart';
+
+/// Object specifying creation parameters for creating a [PlatformAdsLoader].
+///
+/// Platform specific implementations can add additional fields by extending
+/// this class.
+///
+/// This example demonstrates how to extend the
+/// [PlatformAdsLoaderCreationParams] to provide additional platform specific
+/// parameters.
+///
+/// When extending [PlatformAdsLoaderCreationParams] additional parameters
+/// should always accept `null` or have a default value to prevent breaking
+/// changes.
+///
+/// ```dart
+/// class AndroidPlatformAdsLoaderCreationParams
+///     extends PlatformAdsLoaderCreationParams {
+///   AndroidPlatformAdsLoaderCreationParams._(
+///     PlatformAdsLoaderCreationParams params, {
+///     this.uri,
+///   }) : super();
+///
+///   factory AndroidAdsLoaderCreationParams.fromPlatformAdsLoaderCreationParams(
+///     PlatformAdsLoaderCreationParams params, {
+///     Uri? uri,
+///   }) {
+///     return AndroidAdsLoaderCreationParams._(params, uri: uri);
+///   }
+///
+///   final Uri? uri;
+/// }
+/// ```
+@immutable
+class PlatformAdsLoaderCreationParams {
+  /// Used by the platform implementation to create a new [PlatformAdsLoader].
+  const PlatformAdsLoaderCreationParams();
+}
+
+/// Interface for a platform implementation of a `AdsLoader`.
+abstract class PlatformAdsLoader extends PlatformInterface {
+  /// Creates a new [PlatformAdsLoader]
+  factory PlatformAdsLoader(
+    PlatformAdsLoaderCreationParams params,
+  ) {
+    assert(
+      InteractiveMediaAdsPlatform.instance != null,
+      'A platform implementation for `interactive_media_ads` has not been set. '
+      'Please ensure that an implementation of `InteractiveMediaAdsPlatform` '
+      'has been set to `InteractiveMediaAdsPlatform.instance` before use. For '
+      'unit testing, `InteractiveMediaAdsPlatform.instance` can be set with '
+      'your own test implementation.',
+    );
+    final PlatformAdsLoader implementation =
+        InteractiveMediaAdsPlatform.instance!.createPlatformAdsLoader(params);
+    PlatformInterface.verify(implementation, _token);
+    return implementation;
+  }
+
+  /// Used by the platform implementation to create a new [PlatformAdsLoader].
+  ///
+  /// Should only be used by platform implementations because they can't extend
+  /// a class that only contains a factory constructor.
+  @protected
+  PlatformAdsLoader.implementation(this.params) : super(token: _token);
+
+  static final Object _token = Object();
+
+  /// The parameters used to initialize the [PlatformAdsLoader].
+  final PlatformAdsLoaderCreationParams params;
+}

packages/interactive_media_ads/lib/src/platform_interface/platform_ads_manager.dart

@@ -0,0 +1,79 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/foundation.dart';
+import 'package:plugin_platform_interface/plugin_platform_interface.dart';
+
+import 'interactive_media_ads_platform.dart';
+
+/// Object specifying creation parameters for creating a [PlatformAdsManager].
+///
+/// Platform specific implementations can add additional fields by extending
+/// this class.
+///
+/// This example demonstrates how to extend the
+/// [PlatformAdsManagerCreationParams] to provide additional platform specific
+/// parameters.
+///
+/// When extending [PlatformAdsManagerCreationParams] additional parameters
+/// should always accept `null` or have a default value to prevent breaking
+/// changes.
+///
+/// ```dart
+/// class AndroidPlatformAdsManagerCreationParams
+///     extends PlatformAdsManagerCreationParams {
+///   AndroidPlatformAdsManagerCreationParams._(
+///     PlatformAdsManagerCreationParams params, {
+///     this.uri,
+///   }) : super();
+///
+///   factory AndroidAdsManagerCreationParams.fromPlatformAdsManagerCreationParams(
+///     PlatformAdsManagerCreationParams params, {
+///     Uri? uri,
+///   }) {
+///     return AndroidAdsManagerCreationParams._(params, uri: uri);
+///   }
+///
+///   final Uri? uri;
+/// }
+/// ```
+@immutable
+class PlatformAdsManagerCreationParams {
+  /// Used by the platform implementation to create a new [PlatformAdsManager].
+  const PlatformAdsManagerCreationParams();
+}
+
+/// Interface for a platform implementation of a `AdsManager`.
+abstract class PlatformAdsManager extends PlatformInterface {
+  /// Creates a new [PlatformAdsManager]
+  factory PlatformAdsManager(
+    PlatformAdsManagerCreationParams params,
+  ) {
+    assert(
+      InteractiveMediaAdsPlatform.instance != null,
+      'A platform implementation for `interactive_media_ads` has not been set. '
+      'Please ensure that an implementation of `InteractiveMediaAdsPlatform` '
+      'has been set to `InteractiveMediaAdsPlatform.instance` before use. For '
+      'unit testing, `InteractiveMediaAdsPlatform.instance` can be set with '
+      'your own test implementation.',
+    );
+    final PlatformAdsManager implementation = InteractiveMediaAdsPlatform
+        .instance!
+        .createPlatformAdsManager(params);
+    PlatformInterface.verify(implementation, _token);
+    return implementation;
+  }
+
+  /// Used by the platform implementation to create a new [PlatformAdsManager].
+  ///
+  /// Should only be used by platform implementations because they can't extend
+  /// a class that only contains a factory constructor.
+  @protected
+  PlatformAdsManager.implementation(this.params) : super(token: _token);
+
+  static final Object _token = Object();
+
+  /// The parameters used to initialize the [PlatformAdsManager].
+  final PlatformAdsManagerCreationParams params;
+}

packages/interactive_media_ads/lib/src/platform_interface/platform_ads_manager_delegate.dart

@@ -0,0 +1,81 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/foundation.dart';
+import 'package:plugin_platform_interface/plugin_platform_interface.dart';
+
+import 'interactive_media_ads_platform.dart';
+
+/// Object specifying creation parameters for creating a
+/// [PlatformAdsManagerDelegate].
+///
+/// Platform specific implementations can add additional fields by extending
+/// this class.
+///
+/// This example demonstrates how to extend the
+/// [PlatformAdsManagerDelegateCreationParams] to provide additional platform
+/// specific parameters.
+///
+/// When extending [PlatformAdsManagerDelegateCreationParams] additional
+/// parameters should always accept `null` or have a default value to prevent
+/// breaking changes.
+///
+/// ```dart
+/// class AndroidPlatformAdsManagerDelegateCreationParams
+///     extends PlatformAdsManagerDelegateCreationParams {
+///   AndroidPlatformAdsManagerDelegateCreationParams._(
+///     PlatformAdsManagerDelegateCreationParams params, {
+///     this.uri,
+///   }) : super();
+///
+///   factory AndroidAdsManagerDelegateCreationParams.fromPlatformAdsManagerDelegateCreationParams(
+///     PlatformAdsManagerDelegateCreationParams params, {
+///     Uri? uri,
+///   }) {
+///     return AndroidAdsManagerDelegateCreationParams._(params, uri: uri);
+///   }
+///
+///   final Uri? uri;
+/// }
+/// ```
+@immutable
+class PlatformAdsManagerDelegateCreationParams {
+  /// Used by the platform implementation to create a new [PlatformAdsManagerDelegate].
+  const PlatformAdsManagerDelegateCreationParams();
+}
+
+/// Interface for a platform implementation of a `AdsManagerDelegate`.
+abstract class PlatformAdsManagerDelegate extends PlatformInterface {
+  /// Creates a new [PlatformAdsManagerDelegate]
+  factory PlatformAdsManagerDelegate(
+    PlatformAdsManagerDelegateCreationParams params,
+  ) {
+    assert(
+      InteractiveMediaAdsPlatform.instance != null,
+      'A platform implementation for `interactive_media_ads` has not been set. '
+      'Please ensure that an implementation of `InteractiveMediaAdsPlatform` '
+      'has been set to `InteractiveMediaAdsPlatform.instance` before use. For '
+      'unit testing, `InteractiveMediaAdsPlatform.instance` can be set with '
+      'your own test implementation.',
+    );
+    final PlatformAdsManagerDelegate implementation =
+        InteractiveMediaAdsPlatform.instance!
+            .createPlatformAdsManagerDelegate(params);
+    PlatformInterface.verify(implementation, _token);
+    return implementation;
+  }
+
+  /// Used by the platform implementation to create a new
+  /// [PlatformAdsManagerDelegate].
+  ///
+  /// Should only be used by platform implementations because they can't extend
+  /// a class that only contains a factory constructor.
+  @protected
+  PlatformAdsManagerDelegate.implementation(this.params) : super(token: _token);
+
+  static final Object _token = Object();
+
+  /// The parameters used to initialize the [PlatformAdsManagerDelegate].
+  final PlatformAdsManagerDelegateCreationParams params;
+}