BannerView

@objcMembers
@MainActor
public class BannerView:
    UIView,
    BannerEventInteractionDelegate,
    DisplayViewInteractionDelegate

The view that will display the particular banner ad. Built for rendering type of integration.

adUnitConfig
The ad unit configuration.
Declaration
Swift

@MainActor public let adUnitConfig: AdUnitConfig
eventHandler
The event handler for banner view events.
Declaration
Swift

@MainActor public let eventHandler: BannerEventHandler?

Public Properties


                    
                    
                    bannerParameters

Banner-specific parameters.

Declaration

Swift

@MainActor
public var bannerParameters: BannerParameters { get }


                    
                    
                    videoParameters

Video-specific parameters.

Declaration

Swift

@MainActor
public var videoParameters: VideoParameters { get }


                    
                    
                    lastBidResponse

The last bid response received.

Declaration

Swift

@MainActor
public var lastBidResponse: BidResponse? { get }

configID
ID of Stored Impression on the Prebid server
Declaration
Swift

@MainActor public var configID: String { get }


                    
                    
                    refreshInterval

The interval for refreshing the ad.

Declaration

Swift

@MainActor
public var refreshInterval: TimeInterval { get set }


                    
                    
                    additionalSizes

Additional sizes for the ad.

Declaration

Swift

@MainActor
public var additionalSizes: [CGSize]? { get set }


                    
                    
                    adFormat

The ad format (e.g., banner, video).

Declaration

Swift

@MainActor
public var adFormat: AdFormat { get set }


                    
                    
                    adPosition

The position of the ad on the screen.

Declaration

Swift

@MainActor
public var adPosition: AdPosition { get set }


                    
                    
                    delegate

Undocumented

Declaration

Swift

@MainActor
public weak var delegate: BannerViewDelegate?


                    
                    
                    videoPlaybackDelegate

Undocumented

Declaration

Swift

@MainActor
public weak var videoPlaybackDelegate: BannerViewVideoPlaybackDelegate?

Public Methods


                    
                    
                    init(frame:configID:adSize:eventHandler:)

Initializes a new BannerView.

Declaration

Swift

@MainActor
public init(
    frame: CGRect,
    configID: String,
    adSize: CGSize,
    eventHandler: BannerEventHandler
)

Parameters

`frame`	The frame rectangle for the view.
`configID`	The configuration ID for the ad unit.
`adSize`	The size of the ad.
`eventHandler`	The event handler for the banner view.


                    
                    
                    init(configID:eventHandler:)

Convenience initializer for creating a BannerView with a configuration ID and event handler.

Declaration

Swift

@MainActor
public convenience init(
    configID: String,
    eventHandler: BannerEventHandler
)

Parameters

`configID`	The configuration ID for the ad unit.
`eventHandler`	The event handler for the banner view.


                    
                    
                    init(frame:configID:adSize:)

Convenience initializer for creating a BannerView with a frame, configuration ID, and ad size.

Declaration

Swift

@MainActor
public convenience init(
    frame: CGRect,
    configID: String,
    adSize: CGSize
)

Parameters

`frame`	The frame rectangle for the view.
`configID`	The configuration ID for the ad unit.
`adSize`	The size of the ad.

loadAd()
Loads the ad for the banner view.
Declaration
Swift

@MainActor public func loadAd()


                    
                    
                    setStoredAuctionResponse(storedAuction:)

Sets the stored auction response.

Declaration

Swift

@MainActor
public func setStoredAuctionResponse(storedAuction: String)

Parameters


                                storedAuction

The stored auction response string.

Arbitrary ORTB Configuration


                    
                    
                    setImpORTBConfig(_:)

Sets the impression-level OpenRTB configuration string for the ad unit.

Declaration

Swift

@objc
@MainActor
public func setImpORTBConfig(_ ortbConfig: String?)

Parameters


                                ortbConfig

The impression-level OpenRTB configuration string to set. Can be nil to clear the configuration.

getImpORTBConfig()
Returns the impression-level OpenRTB configuration string.
Declaration
Swift

@objc @MainActor public func getImpORTBConfig() -> String?


                    
                    
                    setGlobalORTBConfig(_:)

Sets the global OpenRTB configuration string for the ad unit. It takes precedence over Targeting.setGlobalOrtbConfig.

Declaration

Swift

@MainActor
public func setGlobalORTBConfig(_ ortbConfig: String?)

Parameters


                                ortbConfig

The global OpenRTB configuration string to set. Can be nil to clear the configuration.

getGlobalORTBConfig()
Returns the global OpenRTB configuration string.
Declaration
Swift

@MainActor public func getGlobalORTBConfig() -> String?
stopRefresh()
Stops the auto-refresh of the ad.
Declaration
Swift

@MainActor public func stopRefresh()

Custom Renderer


                    
                    
                    setPluginEventDelegate(_:)

Subscribe to plugin renderer events

Declaration

Swift

@MainActor
public func setPluginEventDelegate(_ pluginEventDelegate: PluginEventDelegate)

DisplayViewInteractionDelegate


                    
                    
                    trackImpression(forDisplayView:)

Declaration

Swift

@MainActor
public func trackImpression(forDisplayView: UIView)


                    
                    
                    viewControllerForModalPresentation(fromDisplayView:)

Declaration

Swift

@MainActor
public func viewControllerForModalPresentation(
    fromDisplayView: UIView
) -> UIViewController?


                    
                    
                    didLeaveApp(from:)

Declaration

Swift

@MainActor
public func didLeaveApp(from displayView: UIView)


                    
                    
                    willPresentModal(from:)

Declaration

Swift

@MainActor
public func willPresentModal(from displayView: UIView)


                    
                    
                    didDismissModal(from:)

Declaration

Swift

@MainActor
public func didDismissModal(from displayView: UIView)

BannerEventInteractionDelegate

willPresentModal()
Undocumented
Declaration
Swift

@MainActor public func willPresentModal()
didDismissModal()
Undocumented
Declaration
Swift

@MainActor public func didDismissModal()
willLeaveApp()
Undocumented
Declaration
Swift

@MainActor public func willLeaveApp()


                    
                    
                    viewControllerForPresentingModal

Undocumented

Declaration

Swift

@MainActor
public var viewControllerForPresentingModal: UIViewController? { get }