BannerAdController class

An Banner Ad Controller model to communicate with the model on the platform side. It gives you methods to help in the implementation and event tracking. It's supposed to work alongside BannerAd, the class used to show the ad in the UI and add it to the widget tree.

For more info, see:

Inheritance

Constructors

BannerAdController({Duration loadTimeout = kDefaultLoadTimeout, Duration timeout = kDefaultAdTimeout})
Creates a new native ad controller

Properties

channel ↔ MethodChannel
Channel to communicate with controller
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
The unique key of this class
no setterinherited
isAttached → bool
Check if the controller is attached to an Ad
no setterinherited
isAvailable → bool
Check if the time is available. If ad is not loaded, returns false If it has been the time of timeout since the last load, returns false
no setterinherited
isDisposed → bool
Check if the ad is disposed. You can dispose the ad by calling ad.dispose()
no setterinherited
isLoaded ↔ bool
Check if the ad is loaded
getter/setter pairinherited
lastLoadedTime ↔ DateTime?
getter/setter pairinherited
loadTimeout → Duration
The ad will stop loading after a specified time.
finalinherited
nonPersonalizedAds → bool
Whether non-personalized ads (ads that are not based on a user’s past behavior) should be enabled.
finalinherited
onEvent → Stream<Map<BannerAdEvent, dynamic>>
Listen to the events the controller throws
no setteroverride
onEventController → StreamController<Map<BannerAdEvent, dynamic>>
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverSideVerificationOptions → ServerSideVerificationOptions?
Server Side Verification - Info such as userId and customData
finalinherited
timeout → Duration
The time the ad can be kept loaded.
finalinherited
unitId → String?
The unit id used on this ad. Can be null
finalinherited

Methods

attach([bool attach = true]) → void
Attach the controller to an Ad Throws an AssertionException if the controller is already attached.
inherited
dispose() → void
Dispose the controller to free up resources. Once disposed, the controller can not be used anymore
override
ensureAdAvailable() → void
inherited
ensureAdNotDisposed() → void
inherited
init() → void
Initialize the controller. This can be called only by the controller
override
load({bool force = false, Duration? timeout}) → Future<bool>
Load the ad. The ad needs to be loaded to be rendered.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
show() → Future<bool>
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

testUnitId → String
The test id for this ad.
no setter