PrebidMobile 2.3.0 Docs (92% documented)

PrebidMobile Classes NativeAd Class Reference

NativeAd

@objcMembers
public class NativeAd : NSObject, CacheExpiryDelegate

Represents a native ad and handles its various properties and functionalities.

Public properties

nativeAdMarkup
The native ad markup containing the ad assets.
Declaration
Swift

public var nativeAdMarkup: NativeAdMarkup?
delegate
The delegate to receive native ad events.
Declaration
Swift

public weak var delegate: NativeAdEventDelegate?

Array getters

titles
Returns an array of titles from the native ad markup.
Declaration
Swift

@objc public var titles: [NativeTitle] { get }
dataObjects
Returns an array of data objects from the native ad markup.
Declaration
Swift

@objc public var dataObjects: [NativeData] { get }
images
Returns an array of images from the native ad markup.
Declaration
Swift

@objc public var images: [NativeImage] { get }
eventTrackers
Returns an array of event trackers from the native ad markup.
Declaration
Swift

@objc public var eventTrackers: [NativeEventTrackerResponse]? { get }

Filtered array getters

dataObjects(of:)
Returns an array of data objects filtered by the specified data type.
Declaration
Swift

@objc public func dataObjects(of dataType: NativeDataAssetType) -> [NativeData]
images(of:)
Returns an array of images filtered by the specified image type.
Declaration
Swift

@objc public func images(of imageType: NativeImageAssetType) -> [NativeImage]

Property getters

title
Returns the first title text from the native ad markup.
Declaration
Swift

@objc public var title: String? { get }
imageUrl
Returns the URL of the main image from the native ad markup.
Declaration
Swift

@objc public var imageUrl: String? { get }
iconUrl
Returns the URL of the icon image from the native ad markup.
Declaration
Swift

@objc public var iconUrl: String? { get }
sponsoredBy
Returns the sponsored by text from the native ad markup.
Declaration
Swift

@objc public var sponsoredBy: String? { get }
text
Returns the description text from the native ad markup.
Declaration
Swift

@objc public var text: String? { get }
callToAction
Returns the call-to-action text from the native ad markup.
Declaration
Swift

@objc public var callToAction: String? { get }


                    
                    
                    create(cacheId:)

Creates a NativeAd instance from the given cache ID.

Declaration

Swift

public static func create(cacheId: String) -> NativeAd?

Parameters


                                cacheId

The cache ID to retrieve the bid response.

Return Value

A NativeAd instance if successful, otherwise nil.


                    
                    
                    registerView(view:clickableViews:)

Registers a view for tracking viewability and click events.

Declaration

Swift

@discardableResult
public func registerView(view: UIView?, clickableViews: [UIView]?) -> Bool

Parameters

`view`	The view to register.
`clickableViews`	An array of views that should be clickable.

Return Value

true if the view was successfully registered, otherwise false.